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

GitHub Action

Release a Changelog

v1.0.1

Release a Changelog

align-justify

Release a Changelog

Creates a GitHub release based on Keep a Changelog

Installation

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

              

- name: Release a Changelog

uses: rasmus-saks/[email protected]

Learn more about this action in rasmus-saks/release-a-changelog-action

Choose a version

Release-a-Changelog action

This GitHub action creates a release based on your CHANGELOG.md file. You must use Keep a Changelog format or this will not work.

Installation

Add the following to a new .github/workflows/release_a_changelog.yml file (or as part of your existing workflow):

name: Release a Changelog

on:
  push:
    branches:
      - master

jobs:
  release_a_changelog:
    name: Release a Changelog
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Release a Changelog
        uses: rasmus-saks/[email protected]
        with:
          github-token: '${{ secrets.GITHUB_TOKEN }}'

⚠️ Make sure you have a checkout action before release-a-changelog, otherwise it won't be able to read your CHANGELOG.md file

Usage

  1. Add a new version to CHANGELOG.md according to Keep a Changelog
  2. Push/merge to master
  3. ???
  4. Profit