feat: support workflow_dispatch for build description#20
Merged
Conversation
The `description` fallback relied on `head_commit.message`, which is only
populated on `push` events. On `workflow_dispatch` (and `schedule`,
`repository_dispatch`, `workflow_run`) the build description degraded to
`Commit <sha>`.
Adds a `github-token` input (defaulting to `${{ github.token }}`) and
fetches the commit via the GitHub API when the payload lacks it. API
failures are warned and still fall back to `Commit <sha>`.
Also fixes empty `status.required:` in action.yml.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Bump actions/upload-artifact from v3 to v4 so check-dist is no longer
auto-failed by GitHub's deprecation policy during job setup.
- Remove the `test` job in test.yml. It invoked `uses: ./` with only
`milliseconds: 1000` (a leftover from the actions/typescript-action
template), had no valid `action` input, and crashed on the
`const { id, ... } = build` destructure in action.js. It was dead
code that never exercised this action meaningfully; the `units` job
runs the real unit tests.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
rqbazan
commented
Apr 24, 2026
Comment on lines
-17
to
-25
|
|
||
| # test action works running from the graph | ||
| test: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: ./ | ||
| with: | ||
| milliseconds: 1000 |
Contributor
Author
There was a problem hiding this comment.
Leftover from when the repo was bootstrapped as a fork of actions/javascript-action in 327daaf (2023-04-12): at that commit action.yml declared a milliseconds input and index.js was the template's wait code, so the job passed.
Six days later b52f3e3 ("Build action") replaced the template with the Nullplatform action — milliseconds was gone — but test.yml was never updated. Since then: empty action input → no CREATE/UPDATE match → core.setFailed(...) without return → const { id, ... } = build crashes on null.
No merged PR since has seen it pass (older run logs were purged by retention, but this PR's run_number on units-test was #43 and the only merge since b52f3e3 is docs-only #19). Restoring it properly needs real credentials or a mock server — out of scope here; units already runs npm test.
francocirulli95
approved these changes
Apr 24, 2026
Move getCommitMessage from action.js into its own module so it can be unit-tested in isolation. action.js still re-imports and uses it the same way (no behavior change). Added src/commit.test.js with @actions/core and @actions/github mocked, covering: empty token short-circuit, success path, and API failure (warns + returns null). Addresses review feedback on PR #20 from @francocirulli95.
Replace the unit test on getCommitMessage (commit.test.js) with an integration test on run() (action.test.js) that mocks @actions/core, @actions/github and HttpClient. The new test asserts the real invariant — the description sent to the nullplatform build API — across five scenarios: - push event with head_commit - workflow_dispatch with valid token (API succeeds) - workflow_dispatch with empty token - workflow_dispatch with API failure - explicit description input wins over payload and API The previous unit test was effectively a tautology: it mocked the same octokit method it then asserted against, so it could not catch a reordering of the `||` chain in createBuild or a misuse of the helper. The integration test covers all three branches of getCommitMessage indirectly while validating the path that actually matters. Addresses review feedback on PR #20 from @francocirulli95. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The dedicated module was overkill for a 20-line helper used in a single place. Inlining keeps action.js self-contained without losing readability. The integration test in action.test.js is unaffected because it asserts on run() behavior, not on the module boundary. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
github-tokeninput (default${{ github.token }}) socreateBuildcan fetch the commit message from the GitHub API when the event payload has nohead_commit(e.g.workflow_dispatch,schedule,repository_dispatch,workflow_run).head_commit.message→ API →Commit <sha>. API errors are logged as warnings and fall through, so the action never breaks on a missing token.status.required:inaction.yml; documents the new input in the README; rebuildsdist/.Permissions
The API call needs
contents: readon the token. Default${{ github.token }}has it unless the consumer restrictspermissions:. On failure we warn and useCommit <sha>.Test plan
npm run lintnpm test(6/6)npm run prepareregeneratesdist/index.jsworkflow_dispatch→ description matches commit messagepush→ payload path still wins (no API call)🤖 Generated with Claude Code