https://github.com/intuit/commently

😀💬 Easily comment and update comments on GitHub PRs
https://github.com/intuit/commently

cicd devops tools typescript

Last synced: 2 months ago
JSON representation

😀💬 Easily comment and update comments on GitHub PRs

• Host: GitHub
• URL: https://github.com/intuit/commently
• Owner: intuit
• License: mit
• Created: 2019-02-26T19:34:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-04T07:41:11.000Z (2 months ago)
• Last Synced: 2024-12-04T08:32:08.460Z (2 months ago)
• Topics: cicd, devops, tools, typescript
• Language: TypeScript
• Homepage:
• Size: 2.42 MB
• Stars: 58
• Watchers: 3
• Forks: 13
• Open Issues: 86
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/Contributing.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# commently - Comment easily 😀💬

[![npm](https://img.shields.io/npm/v/commently.svg)](https://www.npmjs.com/package/commently)

[![CircleCI](https://circleci.com/gh/intuit/commently/tree/master.svg?style=shield)](https://circleci.com/gh/intuit/commently/tree/master)

[![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)

[![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)

[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)



`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.

## Installation

```

yarn add commently-cli --dev

```

Alternatively, you can run via `npx`

```

npx commently-cli

```

## Usage

```

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

```

## Development Setup

To get started developing `commently` run the following commands from the root directory.

```sh

yarn

yarn build:watch

```

## Dev Usage

```sh

yarn 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.

### Clean

Remove all dependencies and build versions.

```sh

yarn clean

```

## License

`commently` is provided under the MIT license.