Skip to content
snyk

GitHub Action

Release-Notes-Preview

v1.6.2 Latest version

Release-Notes-Preview

snyk

Release-Notes-Preview

Presents a preview of expected release notes should the PR get merged, based on Semantic Release

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Release-Notes-Preview

uses: snyk/release-notes-preview@v1.6.2

Learn more about this action in snyk/release-notes-preview

Choose a version

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/release-notes-preview@v1.6.1
      with:
        releaseBranch: master
      env:
        GITHUB_PR_USERNAME: ${{ github.actor }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}