Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce dedicated CHANGELOG file #64

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thomaseizinger
Copy link

@thomaseizinger thomaseizinger commented Jul 6, 2020

We are using dependabot to keep our dependencies up-to-date.

Dependabot parses the CHANGELOG file of a dependency if it is present and includes it in the PR it opens. See this PR for an example: comit-network/comit-rs#2926

Compare this to the PR for the recent directories version bump: comit-network/comit-rs#2923

This patch moves the changelog from the README to a dedicated CHANGELOG.md file so the relevant sections can be automatically included by dependabot on version bumps.
I've borrowed the syntax from keep-a-changelog but omitted the links to tags because there are none unfortunately.

I've also skimmed the commit history and included some of the changes in the changelog.

@soc soc force-pushed the main branch 2 times, most recently from 64c2f24 to 358bc1e Compare March 19, 2023 12:51
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.

1 participant