sticky-pull-request-comment - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #android #machine-learning #rust #deep-learning #docker #macos #windows #awesome #kubernetes #vue #security #ios

sticky-pull-request-comment

(★ 647)

create comment on pull request, if exists update that comment.

File Explorer

Download Latest Version (.zip)

- - test.yml
- dependabot.yml
- - result
  - result2
- comment.test.ts
- config.test.ts
- main.test.ts
- validate.test.ts
- index.js
- index.js.map
- comment.ts
- config.ts
- main.ts
- validate.ts
.gitattributes
.gitignore
.tool-versions
action.yml
biome.json
LICENSE
package-lock.json
package.json
README.md
rollup.config.ts
tsconfig.json
vitest.config.ts

# Installation Guide

1. Get the code

git clone https://github.com/marocchino/sticky-pull-request-comment

Downloads the entire project code from GitHub to your computer.

cd sticky-pull-request-comment

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sticky Pull Request Comment

Create a comment on a pull request, if it exists update that comment.
This library runs with GitHub Actions. If you feel that the example grammar below is not friendly enough, we recommend reading [this page](https://docs.github.com/en/actions) first.

## Usage

### Basic

You need to add permissions for this tool.

```yaml
permissions:
  pull-requests: write
```

```yaml
uses: marocchino/sticky-pull-request-comment@v3
with:
  message: |
    Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>
```

### Keep more than one comment

In some cases, different actions may require different comments. The header allows you to maintain comments independently.

````yaml
release:
  ...
  - uses: marocchino/sticky-pull-request-comment@v3
    with:
      header: release
      message: |
        Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>

test:
  ...
  - name: Run Test
    run: |
      EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
      {
        echo "TEST_RESULT<<$EOF"
        rake test
        echo "$EOF"
      } >> "$GITHUB_ENV"
  - uses: marocchino/sticky-pull-request-comment@v3
    with:
      header: test
      message: |
        ```
        ${{ env.TEST_RESULT }}
        ```
````

### Append after comment every time it runs

````yaml
test:
  ...
  - name: Run Test
    run: |
      EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
      {
        echo "TEST_RESULT<<$EOF"
        rake test
        echo "$EOF"
      } >> "$GITHUB_ENV"
  - uses: marocchino/sticky-pull-request-comment@v3
    with:
      append: true
      message: |
        Test with ${{ github.sha }}.
        ```
        ${{ env.TEST_RESULT }}
        ```
````

### Comment from push

If for some reason, triggering on pr is not possible, you can use push.

```yaml
- uses: jwalton/gh-find-current-pr@v1
  id: finder
- uses: marocchino/sticky-pull-request-comment@v3
  with:
    number: ${{ steps.finder.outputs.pr }}
    message: |
      Test ${{ github.sha }} ended successfully.
      This message is from a push.
```

### Override pull request number

Use `number_force` to comment on a different pull request than the one that triggered the event.

```yaml
- uses: marocchino/sticky-pull-request-comment@v2
  with:
    number_force: 123
    message: |
      This comment will be posted to PR #123,
      regardless of which PR triggered this workflow.
```

### Read comment from a file

```yaml
uses: marocchino/sticky-pull-request-comment@v3
with:
  path: path-to-comment-contents.txt
```

### Embed file content inside a message template

Use `{{{content}}}` as a placeholder in the `message` to insert file content at that position.

````yaml
- name: Run Test
  run: rake test > result.txt
- uses: marocchino/sticky-pull-request-comment@v3
  with:
    path: result.txt
    message: |
      ```
      {{{content}}}
      ```
````

### Delete the previous comment and add a comment at the end

```yaml
uses: marocchino/sticky-pull-request-comment@v3
with:
  recreate: true
  message: |
    Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>
```

### Delete previous comment

```yaml
uses: marocchino/sticky-pull-request-comment@v3
with:
  header: <same-header-as-the-step-that-added-the-comment>
  delete: true
```

### Hide the previous comment and add a comment at the end

```yaml
uses: marocchino/sticky-pull-request-comment@v3
with:
  hide_and_recreate: true
  hide_classify: "OUTDATED"
  message: |
    Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>
```

### Hide previous comment

```yaml
uses: marocchino/sticky-pull-request-comment@v3
with:
  header: <same-header-as-the-step-that-added-the-comment>
  hide: true
  hide_classify: "OUTDATED"
```

### Error: Resource not accessible by integration

This tool requires write permission, and that message means the requester does not have enough permission.
Recently, GitHub sets permissions conservatively for newly created repositories. If it's a newly created repository, check your Settings > Actions > General > Workflow permissions, and make sure to enable read and write permissions.

Then, you can specify permissions for the job like this:

```yaml
permissions:
  pull-requests: write
```

If your repository is private, setting this setting removes all default permissions on your workflow, so for the actions/checkout step to work which is highly common, you will also need the `contents` permissions set.
Otherwise you will get an error such as "fatal: repository *** not found"

```yaml
permissions:
  pull-requests: write
  contents: read
```

For more detailed information about permissions, you can read from the link below:
<https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs>

## Inputs

### `header`

**Optional** Header to determine if the comment should be updated (it is not shown to users). It can be used when you want to add multiple comments independently to a given object.

### `append`

**Optional** Indicate if new comment messages should be appended to previous comment message. Only `true` is allowed. Just skip this option when you don't need it.

### `recreate`

**Optional** Indicate if previous comment should be removed before creating a new comment. Only `true` is allowed. Just skip this option when you don't need it.

### `delete`

**Optional** Delete a previously created comment. Use `header` to point to which comment you want to delete. Only `true` is allowed (i.e. delete this option if you don't need it).

### `only_create`

**Optional** Only create a new comment if there is no existing one, otherwise do nothing. Only `true` is allowed. Just skip this item when you don't need it. This options has higher priority than hide_and_recreate, hide.

### `only_update`

**Optional** Only update a exist comment if there is existing one, otherwise do nothing. Only `true` is allowed. Just skip this item when you don't need it.

### `hide`

**Optional** Hide a previously created comment. Use `header` to point to which comment you want to delete. Only `true` is allowed (i.e. delete this option if you don't need it).

### `hide_classify`

**Optional** The reasons a piece of content can be reported or minimized. SPAM, ABUSE, OFF_TOPIC, OUTDATED, DUPLICATE, RESOLVED are available. default is OUTDATED.

### `hide_details`

**Optional** Hide summary tags in the previously created comment. Only `true` is allowed. Just skip this item when you don't need it.

### `hide_and_recreate`

**Optional** Indicate if previous comment should be removed before creating a new comment. Only `true` is allowed. Just skip this option when you don't need it.

### `message`

**Optional** Comment message. When used together with `path`, use `{{{content}}}` as a placeholder in the message where the file content should be inserted.

### `path`

**Optional** Path to file containing comment message. When `message` is also provided and contains `{{{content}}}`, the file content is embedded at that placeholder position.

### `number`

**Optional** Pull request number for push event. Note that this has a **lower priority** than the number of a pull_request event.

### `number_force`

**Optional** Pull request number for any event. Note that this has the **highest priority** and will override the number from a pull_request event.

### `owner`

**Optional** Another repository owner, If not set, the current repository owner is used by default. Note that when you trying changing a repo, be aware that `GITHUB_TOKEN` should also have permission for that repository.

### `repo`

**Optional** Another repository name. Of limited use on GitHub enterprise. If not set, the current repository is used by default. Note that when you trying changing a repo, be aware that `GITHUB_TOKEN` should also have permission for that repository.

### `ignore_empty`

**Optional** By default this is `false`. If set to `true`, no comment will be posted if the comment body is empty. Note that enabling this will prevent comment hiding & deletion from working when the body is empty.

### `skip_unchanged`

**Optional** By default this is `false`. If set to `true`, recreating or updating a comment will be skipped if the new message is identical to the current message.

### `GITHUB_TOKEN`

**Optional**, You can set [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) here. If not set, this will use `${{ github.token }}`.

## Outputs

### `previous_comment_id`

ID of previous comment, if found

### `created_comment_id`

ID of newly created comment, if any

## Any problem?

Feel free to report issues. 😃