{"id":14155206,"url":"https://github.com/intuit/commently","last_synced_at":"2025-06-21T23:40:12.023Z","repository":{"id":34623308,"uuid":"172776860","full_name":"intuit/commently","owner":"intuit","description":"😀💬 Easily comment and update comments on GitHub PRs","archived":false,"fork":false,"pushed_at":"2025-06-14T10:26:01.000Z","size":2671,"stargazers_count":58,"open_issues_count":88,"forks_count":13,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-14T11:28:03.488Z","etag":null,"topics":["cicd","devops","tools","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/intuit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/Contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-02-26T19:34:01.000Z","updated_at":"2024-12-03T20:05:50.000Z","dependencies_parsed_at":"2024-05-18T03:23:00.857Z","dependency_job_id":"50044806-4f3c-42f2-a342-60f44a855484","html_url":"https://github.com/intuit/commently","commit_stats":null,"previous_names":[],"tags_count":515,"template":false,"template_full_name":null,"purl":"pkg:github/intuit/commently","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intuit%2Fcommently","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intuit%2Fcommently/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intuit%2Fcommently/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intuit%2Fcommently/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/intuit","download_url":"https://codeload.github.com/intuit/commently/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intuit%2Fcommently/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261211973,"owners_count":23125548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cicd","devops","tools","typescript"],"created_at":"2024-08-17T08:02:29.889Z","updated_at":"2025-06-21T23:40:06.957Z","avatar_url":"https://github.com/intuit.png","language":"TypeScript","readme":"# commently - Comment easily 😀💬\n\n[![npm](https://img.shields.io/npm/v/commently.svg)](https://www.npmjs.com/package/commently)\n[![CircleCI](https://circleci.com/gh/intuit/commently/tree/master.svg?style=shield)](https://circleci.com/gh/intuit/commently/tree/master)\n[![CLI Package Known Vulnerabilities](https://snyk.io/test/github/intuit/commently/badge.svg?targetFile=packages%2Fcli%2Fpackage.json)](https://snyk.io/test/github/intuit/commently?targetFile=packages%2Fcli%2Fpackage.json)\n[![Core Package Known Vulnerabilities](https://snyk.io/test/github/intuit/commently/badge.svg?targetFile=packages%2Fcore%2Fpackage.json)](https://snyk.io/test/github/intuit/commently?targetFile=packages%2Fcore%2Fpackage.json)\n[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)\n\n\n\u003cimg width=\"200\" height=\"200\" src=\"./Commently.svg\"\u003e\n\n`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.\n\nAn 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.\n\n## Installation\n\n```\nyarn add commently-cli --dev\n```\n\nAlternatively, you can run via `npx`\n\n```\nnpx commently-cli\n```\n\n## Usage\n\n```\nyarn commently\n\ncommently: Easily comment on PRs\n\n    Required\n\n    --message      String     :    The comment to update the PR with\n\n    Optional:\n\n    --pr           Number     :    The pull request/issue to comment on. Detected in CI env\n    --owner        String     :    The owner for the project. Detected in CI env\n    --repo         String     :    The repo for the project. Detected in CI env\n    --title        String     :    The title of your comment. Defaults to \"Commently\"\n    --key.         String     :    The unique key for your comment. Defaults to \"commently\"\n    --useHistory   Boolean    :    Keep a history of the comments in the comment created by this library\n    --help, -h     Boolean    :    Show the help dialog\n    --verbose, -v  Boolean    :    Output the debug log\n```\n\n## Development Setup\n\nTo get started developing `commently` run the following commands from the root directory.\n\n```sh\nyarn\nyarn build:watch\n```\n\n## Dev Usage\n\n```sh\nyarn build\nGH_TOKEN=YOUR_TOKEN ./packages/cli/dist/cli.js -v --pr 510 --owner intuit --repo commently --message \"Test this\"\n```\n\nThis will build both of the projects.\n\n### Clean\n\nRemove all dependencies and build versions.\n\n```sh\nyarn clean\n```\n\n## License\n\n`commently` is provided under the MIT license.\n","funding_links":[],"categories":["typescript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintuit%2Fcommently","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintuit%2Fcommently","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintuit%2Fcommently/lists"}