https://github.com/software-mansion-labs/pr-description
https://github.com/software-mansion-labs/pr-description
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/software-mansion-labs/pr-description
- Owner: software-mansion-labs
- Created: 2024-01-02T13:53:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-09T14:26:06.000Z (over 1 year ago)
- Last Synced: 2025-02-03T12:48:27.301Z (4 months ago)
- Language: JavaScript
- Size: 84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fork from https://github.com/nefrob/pr-description
# Update Pull Request Description
GitHub action to append or replace text in a pull request description.
## Usage
This action supports `pull_request` and `push` events (where the `push` event ocurred on a branch with an open pull request).
### Inputs
- `content`: The content to append or replace in the PR body. Can be raw text or a file path. If a file path is provided, `contentIsFilePath` must be set to `"true"`.
- `contentIsFilePath`: Whether the `content` input is a file path. Defaults to `"false"`.
- `regex`: The regex to match against the PR body and replace with `content`. Defaults to `"---.*"`.
- `regexFlags`: The regex flags to use. Defaults to `""`.
- `appendContentOnMatchOnly`: Whether to skip appending the `content` to the PR body if no `regex` matches are found. Defaults to `"false"`.
- `token`: The GitHub token to use.
Note: append mode is the default behavior when no `regex` match is found for backwards compatibility with existing action users. This may change in future minor/major versions and will be noted in the [changelog](./CHANGELOG.md).
### Example Workflows
- Simple replace all text in the PR description with `Hello there!`:
```yaml
on:
pull_request:
jobs:
update-pr-description:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Update PR Description
uses: nefrob/[email protected]
with:
content: "Hello there!"
regex: ".*"
regexFlags: i
token: ${{ secrets.GITHUB_TOKEN }}
```
- Reading from a file:
```yaml
on:
pull_request:
jobs:
update-pr-description:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Update PR Description
uses: nefrob/[email protected]
with:
content: path/to/file.txt
contentIsFilePath: true
token: ${{ secrets.GITHUB_TOKEN }}
```
- Replace text in between comments:
`pull_request_template.md` file
```markdown
Anything in between these comments will be replaced by a push to the PR.
```
and workflow
```yaml
on:
pull_request:
jobs:
update-pr-description:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Update PR Description
uses: nefrob/[email protected]
with:
content: "New content!"
regex: ".*?"
regexFlags: ims
token: ${{ secrets.GITHUB_TOKEN }}
```