update-pr-comment

Create and update a PR comment, rather than creating a new one with every run.

Index

• Inputs
• Usage Examples
• Contributing
  • Recompiling
  • Incrementing the Version
• Code of Conduct
• 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

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/update-pr-comment@v1.2.2
        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.
2. 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 and 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:

# Installs dependencies and bundles the code
npm run build

# Bundle the code (if dependencies are already installed)
npm run bundle

These commands utilize esbuild 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.

License

Copyright © 2021, Extend Health, LLC. Code released under the MIT license.