Skip to content
This repository has been archived by the owner on Aug 30, 2023. It is now read-only.
/ release-notes-preview Public archive

GitHub Action for providing release notes preview for semantic releases

License

Notifications You must be signed in to change notification settings

snyk/release-notes-preview

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Known Vulnerabilities

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/checkout@v2
    - run: |
        git fetch --prune --unshallow --tags
    - uses: snyk/[email protected]
      with:
        releaseBranch: master
      env:
        GITHUB_PR_USERNAME: ${{ github.actor }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}