tylermilner / last-successful-commit-hash-action Goto Github PK

Maybe use Danger to help enforce edits to CHANGELOG.md when source changes are made.

There are some linter overrides in main.js that need to be fixed.

See https://docs.github.com/en/actions/creating-actions/releasing-and-maintaining-actions#working-with-the-community.

Improve REAMDE with some additional info:

• Why this action exists
  • Wanted to use an action I own in my projects
  • Didn't initially find other actions that did what I wanted
  • Practice implementing a JavaScript-based action and releasing it to the world
• Alternative actions to consider

The action is currently being tested by the ci workflow, but we should add some proper unit tests.

See the example in the GHA javascript-action template.

One possible approach is suggested in https://docs.github.com/en/actions/creating-actions/releasing-and-maintaining-actions:

• Uses JasonEtco/build-and-tag-action to compile the action code into the dist folder automatically when a release is published to GitHub.
• Once the compilation is complete, a commit is automatically pushed containing the compiled action and the tag that the release was created with is force-updated.
• Other major version tags (e.g. "v1") are also force-updated.
• This release workflow is really built around not checking in the dist folder (i.e. added to gitignore) so that the action is only built by CI upon release, which is probably better from a security standpoint.
• Since the action creates a commit, it requires the contents: write permission defined in the workflow.

Another approach might be softprops/action-gh-release.

This looks interesting for drafting releases as well: https://github.com/release-drafter/release-drafter.

Another one to look at (though it's for a composite action example): https://github.com/cloudposse/github-actions-workflows-github-action-composite

We're using core.debug() statements now, but there are some improvements that can be made.

First, using the action's debug input is no longer working, since core.debug() output is suppressed unless debug logging is enabled for the repository:

We also need to remove the core.debug() statements from the if (debug) blocks.

I still think it's nice to have some debugging functionality that doesn't rely on the ACTIONS_STEP_DEBUG environment variable for quick testing and letting users enable debugging for a single action instead of the whole workflow run. We should look into examples of how other actions have enabled a debug mode via regular input parameters.

It could use a few comments.