Skip to content

mrwake-dev/release-changelog

Repository files navigation

release-changelog

Based on automatic-releases with further changelog customizations.
Requires use of semantic versioning on tags

Required Node.js in GitHub Action >=20

Usage

- name: Set tag name output
  id: vars
  run: echo ::set-output name=tag::${GITHUB_REF#refs/*/}

- name: Create release
  uses: mrwake-dev/release-changelog@v2
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    title: 'YOUR APP NAME ${{ steps.vars.outputs.tag }}'
    files: |
      LICENSE

Supported sections

  • feat, new - 🚀 Features
  • update - 🔄 Updates
  • fix - 🔧 Bug Fixes
  • docs - 📝 Documentation
  • styles - 🎨 Styles
  • refactor - 🔀 Code Refactoring
  • perf - ⚡️ Performance Improvements
  • test - 🧪 Tests
  • build - 🔨 Builds
  • ci - 🔁 Continuous Integration
  • chore - 🧹 Chores
  • revert - ↩️ Reverts
  • remove - 🔥 Removals
  • security - 🔒️ Security
  • breaking - 💥 Breaking Changes
  • other - 🏷️ Other Changes

Commit message format examples

- new: Add new feature
- update: Update feature
- fix: Fix bug
- styles(css): Change style
- refactor(manager): Refactor code

Arguments

  token:
    required: true
    description: repository token
  draft:
    required: false
    description: Create a draft release
    default: 'false'
  pre-release:
    required: false
    description: Create a pre-release release
    default: 'false'
  title:
    required: false
    description: Title for release, defaults to the tag name
  files:
    required: false
    description: Files to include in the release
  skip-prereleases:
    required: false
    description: If enabled, when a new non-prerelease tag is pushed, the changelog will be created between the pushed tag, and the last non-prerelease tag

Originally created by MC-Machinations

About

Github Action for generating automatic changelog on tag commit.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors