Skip to content

Release-Notes-Preview

Actions
Presents a preview of expected release notes should the PR get merged, based on Semantic Release
v1.6.2
Latest
By snyk
Verified creator
Star (77)

Verified

GitHub has manually verified the creator of the action as an official partner organization. For more info see About badges in GitHub Marketplace.

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

Release-Notes-Preview is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Presents a preview of expected release notes should the PR get merged, based on Semantic Release
v1.6.2
Latest
By snyk

Verified

GitHub has manually verified the creator of the action as an official partner organization. For more info see About badges in GitHub Marketplace.

Release-Notes-Preview is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.