snyk / Release Notes Preview
Licence: apache-2.0
GitHub Action for providing release notes preview for semantic releases
Stars: ✭ 31
Programming Languages
typescript
32286 projects
snyk/release-notes-preview
Summary
GitHub Action to provide preview of expected release notes based on Semantic Release.
The preview would be posted on every pull request opened against the desired branch(es).
A pending commit status titled Release Notes Confirmation
would be created when initially posting the release notes.
The commit status would change to success once the checkbox at the bottom of the release notes preview is checked.
Setup
Create a file with the following content under .github/workflows/release-notes.yaml
:
name: Release-Notes-Preview
on:
pull_request:
branches: [ master ]
issue_comment:
types: [ edited ]
jobs:
preview:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- run: |
git fetch --prune --unshallow --tags
- uses: snyk/[email protected]
with:
releaseBranch: master
env:
GITHUB_PR_USERNAME: ${{ github.actor }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].