Repository files navigation

GitHub Action for creating changelog based GitHub Releases

• Requirements
  • Tag section
• Usage
  • Basic usage
  • Customizing
  • Outputs
  • Permissions
• License

As this Action uses thechangelog2versionto parse and extract informations from a changelog, the requirements for thechangelog format have to meet certain criterias.

The header of an entry in the changelog has to follow the following format ifnot specified differently with theversion-line-regex and/orsemver-line-regexoption in the workflow.

This changelog entry shall follow thesemantic version pattern and shall match the followingpattern:

## [x.y.z] - yyyy-mm-dd or## [x.y.z] - yyyy-mm-ddThh:mm:ss

The line shall start with two hashtags (##) followed by a single space ().The semver version withx,y andz as non-negative integers, seperatedby a dot (.) and surrounded by square brackets ([]). Followed by a space(), a dash (-), another space () and theISO8601 formatteddate. Additional timestamps after the date, seperated from the date by asingle space () or a capital (T), are optional. The semantic version taginside the square brackets ([]) supports the full semantic versioning scope.

Examples:

• ## [1.2.3] - 2022-11-13
• ## [1.2.3-alpha-a.b-c-somethinglong+build.1-aef.1-its-okay] - 2022-11-13T12:34:56

Thechangelog of this repo is an example of how the changelogshall look like to be parsable with the default changelog2version settings.

With the default values used a GitHub release and tag based on the changeloglocated in the project root will be created. For further details check thecustomizing section

Seeaction.yml

name:Create releaseon:push:branches:      -mainpermissions:contents:writejobs:release:runs-on:ubuntu-latestname:Releasesteps:      -name:Checkoutuses:actions/checkout@v3      -name:'Create changelog based release'uses:brainelectronics/changelog-based-release@v1

The following are optional asstep.with keys

steps:  -name:Checkoutuses:actions/checkout@v3  -name:'Create changelog based release'uses:brainelectronics/changelog-based-release@v1with:# note you'll typically need to create a personal access token# with permissions to create releases in the other repo# or you set the "contents" permissions to "write" as in this examplegithub-token:${{ secrets.CUSTOM_GITHUB_TOKEN }}changelog-path:path/to/changelog.mdtag-name-prefix:'v'tag-name-extension:'+${{ github.sha }}'release-name-prefix:'Release of'release-name-extension:'-rc'draft-release:trueprerelease:true

The Action provides the following output variables

steps:  -name:Checkoutuses:actions/checkout@v3  -name:'Create changelog based release'uses:brainelectronics/changelog-based-release@v1id:changelog-release  -name:Report action outputrun:|      echo "Latest changelog change description: ${{ steps.changelog-release.outputs.latest-description }}"      echo "Latest changelog version: ${{ steps.changelog-release.outputs.latest-version }}"

This Action requires the following permissions on the GitHub integration token:

permissions:contents:write

GitHub token permissionscan be set for an individual job, workflow, or for Actions as a whole.

The scripts and documentation in this project are released under theMIT License