README.md

changelog-generator

Changelog generator

Generate the changelog between now and the last tag, based on conventional commit.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

The provided script generate a changelog, based on Angular commit message convention.

Changelog format

The changelog is based on all the commits since the last tag. It relies on the Angular commit message convention, to display some nice information. Changes are grouped by type and scope.

Built With

• python
• make

Getting started with command line

To get a local copy up and running follow these steps.

Prerequisites

1. Install python3.7

   sudo apt install python3

2. Install make for development

   sudo apt install make

Installation

1. Clone the changelog-generator

   git clone https://github.com/lumapps/changelog-generator.git

2. Install the dependancies

That's all, your ready to go !

make

Usage

Generate the changelog since the last tag

python3 ./changelog_generator

Getting started with github action

To enable the action simply create the .github/workflows/release.yml file with the following content:

name: Create Release

on:
  push:
    tags:
      - '[0-9]+-[0-9]+-[0-9]+'

jobs:
  build:
    name: Create Release
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Generate changelog
        id: generate_changelog
        uses: lumapps/changelog-generator@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          TAG_PREFIX: # add a prefix here if you have a `prefix/semver` pattern in your repo
      - name: Create Release
        id: create_release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ github.ref }}
          release_name: Release ${{ github.ref }}
          body: ${{ steps.generate_changelog.outputs.changelog }}
          draft: false
          prerelease: false

Roadmap

See the open issues for a list of proposed features (and known issues).

• list all the commit since the last tag
• generate the changelog with a template
• group by type and scope
• properly handle rc version
• properly handle revert commit
• allow hiding some types

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Run the tests (make tests)
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/lumapps/changelog-generator

Acknowledgements

Icons made by Freepik from www.flaticon.com