Comments on a PR when it is included in a GitHub release.
This action comments on a PR when it has commits associated with a release.
This action should typically be called in a worklow with the on.release trigger:
name: PR Comment on Release
on:
release:
types: [published]
permissions:
deployments: write
id-token: write
contents: write
pull-requests: write
jobs:
context:
runs-on: ubuntu-latest
steps:
- name: Comment on Release
uses: cloudposse-github-actions/pr-comment-on-release
id: pr-comment-on-release
with:
# Optional: only comment on PRs when the release matches a certain regex (default: ".*")
include_regex: "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$"This action returns a JSON-encoded string, which contains information on the comments it created (if any):
| Name | Description | Default | Required |
|---|---|---|---|
| include_regex | Only include releases whose tag name matches this regular expression. This regular expression should not include delimeters. i.e. instead of /.\*/g, supply only .\*. |
.* | false |
| retries | Number of retries. | 0 | false |
| tag | The git tag used to determine the release. If omitted, the release will be determined from github.event.release.id. |
N/A | false |
| Name | Description |
|---|---|
| result | A JSON-encoded string which contains information on the comments it created (if any). |
Check out these related projects.
For additional context, refer to some of these links.
- cloudposse-github-actions - Reusable workflows for different types of projects
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:
For 🐛 bug reports & feature requests, please use the issue tracker.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!
Preamble to the Apache License, Version 2.0
Complete license is available in the LICENSE file.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
All other trademarks referenced herein are the property of their respective owners.
Copyright © 2017-2025 Cloud Posse, LLC
{ "comments": [ "pull_request": 1, // the PR # "comment_id": 12345 // the comment ID ] }