Skip to content

Conversation

@blairlearn
Copy link
Contributor

@blairlearn blairlearn commented Oct 16, 2025

  • BREAKING CHANGE:
    There is now a required parameter, config_ref, which specifies
    the branch, tag, or commit hash to use when retrieving the
    commitlint configuration file.

Changes:

  • Run commitlint directly from workflow.
  • Rename commitlint config file to .cjs.
  • Parameterize standards check workflow.
  • Pass module version from test_commitlint workflow.
  • Bump action versions.
  • Adds explicit workflow permissions.

Notes:
Why use commitlint directly instead of via an action?

The wagoid/commitlint-github-action action has a bug/limitation (described in their issue 810) which prevents using a configuration file from outside the $GITHUB_WORKSPACE tree. This is a Docker action which mounts $GITHUB_WORKSPACE; making the runner's /tmp directory inaccessible.

The bulk of the action's code appears to be calculating start and ending commits for linting, which is information GHA provides.

The commitlint documentation provides a guide for setting it up in GitHub actions.

Closes #14
Closes #17

@blairlearn blairlearn changed the base branch from master to workflow/v2 October 16, 2025 20:36
@blairlearn blairlearn force-pushed the ticket/14-module-fix branch 16 times, most recently from 1016a95 to 19eff22 Compare October 20, 2025 14:54
@blairlearn blairlearn changed the title (#14) Handle ecmascript modules too. (#14, #17) Fix linting for ecmascript modules. Oct 20, 2025
@blairlearn blairlearn marked this pull request as ready for review October 20, 2025 15:46
Copy link
Member

@bryanpizzillo bryanpizzillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a number of undocumented changes being made here. Also nothing in the standards workflow should reference a ref.

@blairlearn blairlearn force-pushed the ticket/14-module-fix branch 2 times, most recently from c07f5a2 to 1e62745 Compare October 20, 2025 19:22
@blairlearn blairlearn changed the base branch from workflow/v2 to workflow/v4 October 20, 2025 19:25
@blairlearn blairlearn force-pushed the ticket/14-module-fix branch 4 times, most recently from baea61c to 016a555 Compare October 23, 2025 20:43
- BREAKING CHANGE:
  There is now a required parameter, config_ref, which specifies
  the branch, tag, or commit hash to use when retrieving the
  commitlint configuration file.

Changes:
- Run commitlint directly from workflow.
- Rename commitlint config file to .cjs.
- Parameterize standards check workflow.
- Pass module version from test_commitlint workflow.
- Bump action versions.
- Adds explicit workflow permissions.

Closes #14
Closes #17
@blairlearn blairlearn force-pushed the ticket/14-module-fix branch from 016a555 to 4b308f4 Compare October 23, 2025 20:50
@jfrank-nih
Copy link
Member

@bryanpizzillo bryanpizzillo self-requested a review October 28, 2025 17:07
Copy link
Member

@bryanpizzillo bryanpizzillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jfrank-nih and @blairlearn say this works. Approach looks right

@bryanpizzillo bryanpizzillo merged commit c7bc44b into workflow/v4 Oct 28, 2025
1 of 2 checks passed
@bryanpizzillo bryanpizzillo deleted the ticket/14-module-fix branch October 28, 2025 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Commitlint setup does not work with packages of type module

4 participants