Github actions cheatsheet

github-actions-cheatsheet.md

Github actions cheatsheet

• Variables
  • Inbuild env vars
  • Context
  • Custom env vars

    steps:
      - name: Setting env var which all jobs in the workflow can see
        run: echo 'MY_NEW_ENV_VAR="hello"' >> "$GITHUB_ENV"

• Workflow syntax
  • triggers
    • Events that trigger workflows
  • conditionals/expressions
  • contexts
  • defining permissions
• Skipping workflow runs using commit message tokens
• Packaging
• Caching
• Publishing actions to the GitHub Marketplace
• Override run name:
  • run-name: Running smoke tests on environment [${{ github.event.inputs.environment }}]
• Authentication and GITHUB_TOKENs

Logging

using annotations:

• debug
• notice
• warning
• error

Add annotations with markdown:

steps:
  - name: Adding markdown content to the step summary output
    run: echo '### Hello world! 🚀' >> "$GITHUB_STEP_SUMMARY"

Send slack notification

https://app.slack.com/block-kit-builder/T024VMWJC

      - name: Notify slack channel
        id: slack
        uses: slackapi/slack-github-action@v1.24.0
        with:
          payload: |
            {
              "channel": "#tech",
              "text": ":white_check_mark: *Maintenance mode disabled* \nThe site should be back up and working okay now.\n\n Environment: *${{ github.event.inputs.environment }}* \n Triggered by: ${{ github.actor }}"
            }
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}