GitHub Actions best practices

REAME.md

Set timeouts

Specify timeouts in GitHub Actions to prevent prolonged tasks

timeout-minutes: 5

Catch Bash Pipe Errors

Define the default shell as Bash in the workflow settings, enabling pipefail to detect errors during piping.

defaults:
  run:
    shell: bash --noprofile --norc -eo pipefail {0}

Automatic Workflow Cancellation

Use concurrency to cancel outdated workflows, reducing unnecessary wait times and costs.

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true #

Job-Level Permissions for GITHUB_TOKEN

Control access by disabling default permissions at the workflow level and assigning only necessary permissions per job to minimize security risks.

permissions:
  contents: read