Skip to content

Improve Github Action Workflow #29

@AliceR

Description

@AliceR

@danielfdsilva spent time in #24 improving the GitHub workflow.
To keep our git history clean and make reviews easier, we should extract the workflow improvements into their own PR, based on the develop branch.

GitHub Actions Workflow Updates (.github/workflows/checks.yml)

  • Add descriptive header comments explaining the workflow purpose
  • Update trigger conditions:
    • Remove push trigger on main branch
    • Update pull_request types to: opened, synchronize, reopened, ready_for_review
    • Add concurrency controls to cancel in-progress runs for the same ref
  • Update Node.js version strategy:
    • Remove hardcoded NODE environment variable
    • Use node-version-file: '.nvmrc' to read version from .nvmrc file
  • Update GitHub Actions to latest versions:
    • actions/checkout@v2actions/checkout@v4
    • actions/setup-node@v1actions/setup-node@v4
    • actions/cache@v2actions/cache@v4
    • Remove deprecated styfle/cancel-workflow-action (replaced by concurrency)
  • Simplify cache key:
    • Remove cache-name environment variable
    • Use ${{ runner.os }}-build-${{ hashFiles('**/package.json') }}
  • Update job commands:
    • Use explicit yarn run lint instead of yarn lint
    • Use explicit yarn run test instead of yarn test
    • Use explicit yarn run build instead of yarn build
    • Fix build job step name: "Test" → "Build"
  • Ensure build job depends on test job (not changed, but verify)

References

Notes

This is purely infrastructure/tooling changes with no functional code changes to the library itself.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions