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

Request for Changelog #85

Closed
sgriffith3 opened this issue Oct 3, 2022 · 2 comments
Closed

Request for Changelog #85

sgriffith3 opened this issue Oct 3, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@sgriffith3
Copy link

Is your feature request related to a problem? Please describe.
There was a recent change to git (involving safe directory) that I wanted to investigate, so I came to examine what changed with the last release. To my dismay, there was no CHANGELOG.md.

Describe the solution you'd like
I would like to see a CHANGELOG.md file in the repo

Describe alternatives you've considered
I ended up just looking at the most recent release.

Additional context
It is quite ironic that a tool that makes a changelog does not have a changelog. 😄

@sgriffith3 sgriffith3 added the enhancement New feature or request label Oct 3, 2022
@hdevalke
Copy link
Collaborator

hdevalke commented Oct 3, 2022

You can see the changes in the release https://github.com/convco/convco/releases

You are right the tool should generate a changelog when doing a release. There is currently an issue with the rendering in github flavored markdown. I am busy implementing a feature to remove the word-wrap

@hdevalke
Copy link
Collaborator

hdevalke commented Oct 4, 2022

I added a changelog to the repository. But will keep this ticket open in order to add this to cargo release config to automate this.
But I think i need to add an option to add the unreleased commits to the next version or else there will be a ## Unreleased (2022-09-26) header

hdevalke added a commit that referenced this issue Jan 4, 2023
To prepare a release one can change the Unreleased header to prepare for the next commit.

E.g.

`convco changelog -u $(convco version bump)` will create a changelog for the next version.

This feature will make it possible for release workflows to update the changelog file.

Refs: #85
hdevalke added a commit that referenced this issue Jan 12, 2023
To prepare a release one can change the Unreleased header to prepare for the next commit.

E.g.

`convco changelog -u $(convco version bump)` will create a changelog for the next version.

This feature will make it possible for release workflows to update the changelog file.

Refs: #85
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants