Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
snyk

GitHub Action

Release-Notes-Preview

v1.4.0

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/[email protected]

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).

Prerequisites

An authentication token for GitHub, used for posting the preview of the release notes.

Setup

  1. Generate a GitHub token with sufficient write access to the repository. Privileges depend on whether the project is open sourced or not.
  2. Add the GitHub token as a secret to the repository, named RELEASE_NOTES_GITHUB_TOKEN.
  3. Create a file with the following content under .github/workflows/release-notes.yaml:
name: Release-Notes-Preview

on:
  pull_request:
    branches: [ master ]

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.RELEASE_NOTES_GITHUB_TOKEN }}