https://github.com/siegerts/release-follow-up-action
Follow up on referenced issues and PRs after a release is published. :memo:
https://github.com/siegerts/release-follow-up-action
github-actions issue-management issue-tracking-system release-notes
Last synced: 4 months ago
JSON representation
Follow up on referenced issues and PRs after a release is published. :memo:
- Host: GitHub
- URL: https://github.com/siegerts/release-follow-up-action
- Owner: siegerts
- License: mit
- Created: 2021-03-29T16:49:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T23:23:27.000Z (over 2 years ago)
- Last Synced: 2025-06-04T14:20:24.544Z (4 months ago)
- Topics: github-actions, issue-management, issue-tracking-system, release-notes
- Language: JavaScript
- Homepage:
- Size: 1.39 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Release follow up :memo:
Follow up on issues and PRs after a release is published. The corresponding `pending-release` label will be removed if it's present and the`referenced-in-release` label added.
The relevant issues are parsed from the release body (i.e. changelog/notes) and only recognized if present in the current repo (i.e. where the release is published).
- **Any** issue linked in the release body with the pattern `//issues/` will be matched. If the issue exists in the current repo, a comment will be added referencing the release link.
- Issues and PRs **are not** closed, only commented on.
## Inputs
| Input | Default | Required | Description |
| ----------------------------- | ----------------------- | -------- | ---------------------------------------------------------------------------- |
| `github-token` | | true | The GitHub token used to create an authenticated client |
| `pending-release-label` | `pending-release` | false | Label to remove from referenced issues, if exists |
| `referenced-in-release-label` | `referenced-in-release` | false | Label to add to referenced issues |
| `dry-run` | `false` | false | Log proposed updates against referenced items instead of modifying resources |
## Usage
You can use the action by referencing the v1 branch:
```yaml
name: release-follow-up
on:
release:
types: [published]
jobs:
follow-up:
runs-on: ubuntu-latest
steps:
- uses: siegerts/release-follow-up-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
#### Using `dry-run`
```yaml
name: release-follow-up
on:
release:
types: [published]
jobs:
follow-up:
runs-on: ubuntu-latest
steps:
- uses: siegerts/release-follow-up-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
dry-run: true
```
**Output in the workflow run log**
```
Run mode: dry-run
Issues referenced in the v1.0 release: 5
Updating issue #5...
--removing label
--adding label
--adding comment of type issue for **v1.0** release
```
#### Using different labels
```yaml
name: release-follow-up
on:
release:
types: [published]
jobs:
follow-up:
runs-on: ubuntu-latest
steps:
- uses: siegerts/release-follow-up-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
pending-release-label: to-be-released
referenced-in-release-label: already-released
```