commently is a package for leaving comments on a GitHub PR from CI. However, what makes commently different is that it will update the same comment and keep a history over time. This allows less noise on PRs, and also a way for users to references prior automation.
An example of a use case for commently is preview releases. If your project does a preview build, you can use commently to publish a comment to GitHub with the preview version and instructions for your users on how they can test.
yarn add commently-cli --dev
Alternatively, you can run via npx
npx commently-cli
yarn commently
commently: Easily comment on PRs
Required
--message String : The comment to update the PR with
Optional:
--pr Number : The pull request/issue to comment on. Detected in CI env
--owner String : The owner for the project. Detected in CI env
--repo String : The repo for the project. Detected in CI env
--title String : The title of your comment. Defaults to "Commently"
--key. String : The unique key for your comment. Defaults to "commently"
--useHistory Boolean : Keep a history of the comments in the comment created by this library
--help, -h Boolean : Show the help dialog
--verbose, -v Boolean : Output the debug log
To get started developing commently run the following commands from the root directory.
yarn
yarn build:watchyarn build
GH_TOKEN=YOUR_TOKEN ./packages/cli/dist/cli.js -v --pr 510 --owner intuit --repo commently --message "Test this"This will build both of the projects.
Remove all dependencies and build versions.
yarn cleancommently is provided under the MIT license.