Changelog CI is a GitHub Action that enables a project to automatically generate changelogs. Changelog CI can be triggered on pull_request, workflow_dispatch, and any other events that can provide the required inputs. Changelog CI uses python and GitHub API to generate a changelog for a repository. First, it tries to get the latest release from the repository (If available). Then, it checks all the pull requests/commits merged after the last release using the GitHub API. After that, it parses the data and generates the changelog. It is able to use Markdown or reStructuredText to generate a Changelog. Finally, It writes the generated changelog at the beginning of the CHANGELOG.md/CHANGELOG.rst (or user-provided filename) file. In addition to that, if a user provides a configuration file (JSON/YAML), Changelog CI parses the user-provided configuration file and renders the changelog according to user's configuration.

Features

  • Workflow input options
  • Use an optional configuration file
  • The code in this project is released under the MIT License
  • Changelog CI can be triggered on pull_request, workflow_dispatch and any other events
  • GitHub Action that enables a project to automatically generate changelogs
  • Generate changelog using Pull Request Title or Commit Messages made after the last release

Project Samples

Project Activity

See All Activity >

Categories

Change Detection

License

MIT License

Follow Changelog CI

Changelog CI Web Site

You Might Also Like
Our Free Plans just got better! | Auth0 by Okta Icon
Our Free Plans just got better! | Auth0 by Okta

With up to 25k MAUs and unlimited Okta connections, our Free Plan lets you focus on what you do best—building great apps.

You asked, we delivered! Auth0 is excited to expand our Free and Paid plans to include more options so you can focus on building, deploying, and scaling applications without having to worry about your secuirty. Auth0 now, thank yourself later.
Try free now
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of Changelog CI!

Additional Project Details

Programming Language

Python

Related Categories

Python Change Detection Tool

Registered

2023-10-19