https://github.com/beakyn/gha-comment-pull-request
Action to add comments and edit description in pull requests.
https://github.com/beakyn/gha-comment-pull-request
github-action javascript workflow
Last synced: 10 months ago
JSON representation
Action to add comments and edit description in pull requests.
- Host: GitHub
- URL: https://github.com/beakyn/gha-comment-pull-request
- Owner: Beakyn
- License: mit
- Created: 2021-03-06T02:32:43.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-06-02T23:34:47.000Z (about 3 years ago)
- Last Synced: 2025-07-17T21:09:51.201Z (11 months ago)
- Topics: github-action, javascript, workflow
- Language: JavaScript
- Homepage:
- Size: 583 KB
- Stars: 3
- Watchers: 8
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Comment Pull Request
Action to add comments and edit description in pull requests
## Pre-requisites
Create a workflow .yml file in your .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.
## Inputs
`pull-request-number`: Pull request number. **This is required if not running in a pull_request event**
`description-message`: Append message to pull request description
`comment-message`: Add comment to pull request
`delete-previous-comment`: Delete previous comment
## Example
```yaml
- name: Comment deploy URL to pull request
uses: Beakyn/gha-comment-pull-request@v1.0.1
env:
GITHUB_TOKEN: ${{ github.token }}
with:
description-message: |
----
### Live Preview
:rocket: Released to https://${{steps.environment.outputs.deployUrl}}
comment-message: |
### Live Preview
:rocket: Released to https://${{steps.environment.outputs.deployUrl}}
delete-previous-comment: true
```