/ChangelogAutomation.action

GitHub action to process changelog file.

Primary LanguageJavaScriptMIT LicenseMIT

ChangelogAutomation.action Status Aquana

When preparing a software release, a common task is to parse the changelog file, and extract the latest changes section from it. For certain purposes, Markdown format is acceptable, but in some cases a text format is also useful.

ChangelogAutomation.action is a GitHub action that uses ChangelogAutomation to parse the changelog and provide the output to reuse in a GitHub Actions context.

Usage

Add the following to your .github/workflows/<workflow>.yml:

jobs:
  <job>:
    steps:
      - name: Test Markdown
        uses: ForNeVeR/ChangelogAutomation.action@v1
        with:
          input: ./smth/CHANGELOG.md
          output: ./changelog-section.md

This will read the latest version section of your CHANGELOG.md file and save it to the changelog-section.md file.

Available input parameters are:

  • input (./CHANGELOG.md by default): the input changelog file
  • format (Markdown by default): output file format; either Markdown or PlainText
  • output: the output file where the section content will be written

Development

Node.js v20.0+ and NPM 10.0+ are required to work on this project.

To download the dependencies, run the following shell command:

$ npm install

To build the project distribution (which is then pushed to the repository, as recommended by GitHub), run the following shell command:

$ npm run build

Documentation