https://github.com/zapata-engineering/command-pr-comment
GitHub Action for executing a command and displaying the result as comment on a pull request.
https://github.com/zapata-engineering/command-pr-comment
product-development
Last synced: 5 months ago
JSON representation
GitHub Action for executing a command and displaying the result as comment on a pull request.
- Host: GitHub
- URL: https://github.com/zapata-engineering/command-pr-comment
- Owner: zapata-engineering
- License: other
- Created: 2022-08-06T15:17:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T20:01:06.000Z (about 2 years ago)
- Last Synced: 2024-05-16T07:24:21.660Z (about 2 years ago)
- Topics: product-development
- Language: JavaScript
- Homepage:
- Size: 1.31 MB
- Stars: 2
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```yaml
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`.
```bash
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
```bash
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`.
```bash
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
```bash
git checkout -b v1
git commit -a -m "v1 release"
```
```bash
git push origin v1
```
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)