This action iterates through all PRs that are part of a release and adds a comment to each of them. It runs only when triggered by a release event and a published action.

• Added a new input parameter for specifying custom body text for the posted comment
• Improved documentation

Refer here for previous versions.

Required The GITHUB_TOKEN secret.

Place to set your own custom text for the posted comment. If omitted, the default message shown in the image below will be used. Supports markdown syntax and emojis (see example). The text can contain properties of the release in the form of {{propertyName}}. Full list of available properties can be found in the table below.

List of the IDs of the commented PRs

Here is a list of the release properties which can be used in the custom comment body text via placeholders:

name: Comment on released PRs

on:
  release:
    types:
      - published

jobs:
  comment:
    name: Comment on released PRs
    runs-on: ubuntu-latest
    steps:
      - name: Comment on released PRs
        uses: rdlf0/comment-released-prs-action@v2
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          comment-body: "🙌 This is some sample custom message. 🤣 It supports markdown and emojis! 🎈 You can show information about the release that triggered the action - [{{name}}]({{html_url}}) 💩\r\nOr you can show off with a list:\r\n- Which includes some nonsense\r\n- Or other useless info\r\n- And so on...\r\n\r\nInfo about the author of the release is also available:\r\n![{{author.login}}]({{author.avatar_url}})"

The default comment (if comment-body parameter is not set) posted to the PRs will look like this:

The scripts and documentation in this project are released under the MIT License