Skip to content

keep a changelog#251

Merged
ehsandeep merged 1 commit intomainfrom
keep_a_changelog
Sep 3, 2023
Merged

keep a changelog#251
ehsandeep merged 1 commit intomainfrom
keep_a_changelog

Conversation

@dogancanbakir
Copy link
Copy Markdown
Member

@dogancanbakir dogancanbakir commented Aug 28, 2023

Closes #259.

Proposal

Description:

As our project continues to grow and evolve, it's becoming increasingly important that we keep a comprehensive record of all changes that have occurred in each new version. This will allow both the team and our users to track the evolution of the project easily, its new features, and any bugs or issues that have been addressed.

With this in mind, I propose we create and maintain a CHANGELOG.md file in the root of our repository. This file should detail the changes for each release in an easy-to-read format, ideally following the conventions outlined in Keep a Changelog.

Tasks:

- [x] Create a `CHANGELOG.md` file in the root of one of our repository. It should include a short introduction explaining its purpose and how it's organized.
- [x] Create `changelog-update.yml` (GitHub Action workflow) to automate updating `CHANGELOG.md` file with every new release.

Acceptance Criteria:

  1. A CHANGELOG.md file exists in the repository, including all the historical changelog release notes.
  2. A changelog-update.yml workflow file to automatically update CHANGELOG.md after a new release gets created.

@dogancanbakir dogancanbakir self-assigned this Aug 28, 2023
@ehsandeep ehsandeep merged commit f50137c into main Sep 3, 2023
@ehsandeep ehsandeep deleted the keep_a_changelog branch September 3, 2023 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants