Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/im-open/update-pr-comment
A Github Action for updating a PR comment (rather than creating a new one)
https://github.com/im-open/update-pr-comment
comment customization-team infra-purple-team meta pull-request
Last synced: 29 days ago
JSON representation
A Github Action for updating a PR comment (rather than creating a new one)
- Host: GitHub
- URL: https://github.com/im-open/update-pr-comment
- Owner: im-open
- License: mit
- Created: 2022-02-23T17:55:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T18:24:09.000Z (9 months ago)
- Last Synced: 2024-11-17T20:51:29.063Z (about 1 month ago)
- Topics: comment, customization-team, infra-purple-team, meta, pull-request
- Language: TypeScript
- Homepage:
- Size: 956 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# update-pr-comment
Create and update a PR comment, rather than creating a new one with every run.
## Index
- [Inputs](#inputs)
- [Usage Examples](#usage-examples)
- [Contributing](#contributing)
- [Recompiling](#recompiling)
- [Incrementing the Version](#incrementing-the-version)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Inputs
| Parameter | Is Required | Description |
| -------------------- | ----------- | --------------------------------------------------------------------------- |
| `github-token` | true | The GitHub token for interacting with the repository. |
| `comment-identifier` | true | An unchanging identifier for the comment that should be updated or created. |
| `comment-content` | true | A string of Github-flavored markdown for your comment. |
| `pr-number` | false\* | The number for the target PR. |
| `pr-ref` | false\* | A git ref which points to a commit contained in the target PR. |
| `create-if-not-exists` | false. | If comment does not already exist, create it. Defaults to `true` |
**_\* If the workflow containing this action is not running from a `pull_request` or `pull_request_target` event, one of these parameters is required._**
## Usage Examples
```yml
jobs:
jobname:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
- name: 'Create or Update PR Comment'
# You may also reference just the major or major.minor version.
uses: im-open/[email protected]
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
comment-identifier: 'specific-comment-identifier' # this should not change
# Optional Inputs
# pr-number: 135
# pr-ref: ${{ github.ref }}
comment-content: |
# Comment Content
Some Github-flavored markdown for your comment...
```
## Contributing
When creating new PRs please ensure:
1. For major or minor changes, at least one of the commit messages contains the appropriate `+semver:` keywords listed under [Incrementing the Version](#incrementing-the-version).
1. The action code does not contain sensitive information.
When a pull request is created and there are changes to code-specific files and folders, the build workflow will run and it will recompile the action and push a commit to the branch if the PR author has not done so. The usage examples in the README.md will also be updated with the next version if they have not been updated manually. The following files and folders contain action code and will trigger the automatic updates:
- action.yml
- package.json
- package-lock.json
- src/\*\*
- dist/\*\*
There may be some instances where the bot does not have permission to push changes back to the branch though so these steps should be done manually for those branches. See [Recompiling Manually](#recompiling-manually) and [Incrementing the Version](#incrementing-the-version) for more details.
### Recompiling Manually
If changes are made to the action's code in this repository, or its dependencies, the action can be re-compiled by running the following command:
```sh
# Installs dependencies and bundles the code
npm run build
# Bundle the code (if dependencies are already installed)
npm run bundle
```
These commands utilize [esbuild](https://esbuild.github.io/getting-started/#bundling-for-node) to bundle the action and
its dependencies into a single file located in the `dist` folder.
### Incrementing the Version
Both the build and PR merge workflows will use the strategies below to determine what the next version will be. If the build workflow was not able to automatically update the README.md action examples with the next version, the README.md should be updated manually as part of the PR using that calculated version.
This action uses [git-version-lite] to examine commit messages to determine whether to perform a major, minor or patch increment on merge. The following table provides the fragment that should be included in a commit message to active different increment strategies.
| Increment Type | Commit Message Fragment |
| -------------- | ------------------------------------------- |
| major | +semver:breaking |
| major | +semver:major |
| minor | +semver:feature |
| minor | +semver:minor |
| patch | _default increment type, no comment needed_ |
## Code of Conduct
This project has adopted the [im-open's Code of Conduct](https://github.com/im-open/.github/blob/main/CODE_OF_CONDUCT.md).
## License
Copyright © 2021, Extend Health, LLC. Code released under the [MIT license](LICENSE).
[git-version-lite]: https://github.com/im-open/git-version-lite