https://github.com/snyk/release-notes-preview

GitHub Action for providing release notes preview for semantic releases
https://github.com/snyk/release-notes-preview

github-action prodsec-archived semantic-releases

Last synced: 4 months ago
JSON representation

GitHub Action for providing release notes preview for semantic releases

• Host: GitHub
• URL: https://github.com/snyk/release-notes-preview
• Owner: snyk
• License: apache-2.0
• Archived: true
• Created: 2020-03-13T16:53:41.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-29T13:07:06.000Z (almost 2 years ago)
• Last Synced: 2024-11-22T02:53:23.565Z (5 months ago)
• Topics: github-action, prodsec-archived, semantic-releases
• Language: TypeScript
• Size: 586 KB
• Stars: 77
• Watchers: 89
• Forks: 21
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• jimsghstars - snyk/release-notes-preview - GitHub Action for providing release notes preview for semantic releases (TypeScript)

README

        
[![Known Vulnerabilities](https://snyk.io/test/github/snyk/release-notes-preview/badge.svg?targetFile=package.json)](https://snyk.io/test/github/snyk/release-notes-preview?targetFile=package.json)

# snyk/release-notes-preview #

## Summary ##

GitHub Action to provide preview of expected release notes based on [Semantic Release](https://github.com/semantic-release/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 }}

```