Command PR Comment

This Action is used for executing a command in Github Actions and displaying the result as comment on a pull request. This is useful for showing code coverage stats, details of failing tests and more.

Usage

You can now consume the action by referencing the v1 branch

uses: zapatacomputing/command-pr-comment@v1
with:
  command: make show-coverage-text-report
  template: "🚀 Code Coverage\n```\n%stdout%```"
  update-text: "🚀 Code Coverage"

Development

You can install the dependencies with npm.

npm install

Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

Run prepare

npm run prepare

Since the packaged index.js is run from the dist directory, this will need to be updated when you make changes to index.js.

git add dist
git commit

Create a release branch

Users shouldn't consume the action from main since that would be latest code and actions can break compatibility between major versions.

Checkin to the v1 release branch

git checkout -b v1
git commit -a -m "v1 release"

git push origin v1

See the versioning documentation