Skip to content
align-left

GitHub Action

Generate Gitmoji Changelog

v1.0.0 Latest version

Generate Gitmoji Changelog

align-left

Generate Gitmoji Changelog

GitHub Action for gitmoji-changelog

Installation

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

              
- name: Generate Gitmoji Changelog

              
  uses: sercanuste/gitmoji-changelog-action@v1.0.0
Learn more about this action in sercanuste/gitmoji-changelog-action

Choose a version

Gitmoji gitmoji-changelog

Gitmoji Changelog Action

An action for generate gitmoji changelog.

Usage

name: "Generate Gitmoji Changelog"

on:
  push:
    branches:
      - "main"

jobs:
  generate-changelog:
    runs-on: ubuntu-latest

    steps:
      - name: "Checkout"
        uses: "actions/checkout@v3"
        with:
          fetch-depth: 0 # Required for fetch all history

      - name: "Generate Changelog"
        uses: sercanuste/gitmoji-changelog-action@v1

Inputs

Input Description Required Options  Default Value
commit_message The commit message to use when updating the changelog. false - 📝 Update CHANGELOG 
format Changelog file format false markdown
json		 markdown
preset Preset for gitmoji-changelog. Click for more info. false node
generic
maven
cargo
helm		 node
group_similar_commits [⚗️,- beta] Try to group similar commits. false true
false		 false
add_author Add the author in changelog lines. false true
false		 false
author_email Email address of commit author false - 114694492+gitmoji-changelog-bot@users.noreply.github.com
author_name Name of commit author false - Gitmoji Changelog Bot

License

The scripts and documentation in this project are released under the MIT License