GitHub Action
Conventional Changelog Reader
A GitHub action to read and get data from the CHANGELOG.md files following the Conventional Changelog standard and created by conventional-changelog-cli with conventionalcommits flag: conventional-changelog -p conventionalcommits
Create a workflow .yml file in your repositories .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.
path: The path the action can find the CHANGELOG. Optional. Defaults to./CHANGELOG.md.version: The exact version of the log entry you want to retreive or "Unreleased" for the unreleased entry. Optional. Defaults to the last version number.
version: Version of the log entry found. Ex:2.0.0.date: Release date of the log entry found. Ex:2020-08-22.status: Status of the log entry found (prereleased,released,unreleased, oryanked).changes: Description text of the log entry found.
On every push to a tag matching the pattern v*, create a release using the CHANGELOG.md content.
This Workflow example assumes you'll use the @actions/create-release Action to create the release step:
on:
push:
# Sequence of patterns matched against refs/tags
tags:
- "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
name: Create Release
jobs:
build:
name: Create Release
runs-on: ubuntu-latest
steps:
- name: Get version from tag
id: tag_name
run: |
echo ::set-output name=current_version::${GITHUB_REF#refs/tags/v}
shell: bash
- name: Checkout code
uses: actions/checkout@v2
- name: Get Changelog Entry
id: changelog_reader
uses: artlaman/[email protected]
with:
version: ${{ steps.tag_name.outputs.current_version }}
path: ./CHANGELOG.md
- name: Create/update release
uses: ncipollo/release-action@v1
with:
# This pulls from the "Get Changelog Entry" step above, referencing it's ID to get its outputs object.
# See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
tag: ${{ steps.changelog_reader.outputs.version }}
name: Release ${{ steps.changelog_reader.outputs.version }}
body: ${{ steps.changelog_reader.outputs.changes }}
prerelease: ${{ steps.changelog_reader.outputs.status == 'prereleased' }}
allowUpdates: true
token: ${{ secrets.GITHUB_TOKEN }}Contributions to the source code of Conventional Changelog Reader Action are welcomed and greatly appreciated. For help on how to contribute in this project, please refer to How to contribute to Conventional Changelog Reader Action.
If you like Conventional Changelog Reader Action please star my repository would appreciate that a lot!
The scripts and documentation in this project are released under the MIT License