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

Add a proper changelog #234

Closed
Eric-Arellano opened this issue Mar 28, 2023 · 1 comment
Closed

Add a proper changelog #234

Eric-Arellano opened this issue Mar 28, 2023 · 1 comment

Comments

@Eric-Arellano
Copy link
Collaborator

Right now, we do ad-hoc changelogs in GitHub release notes:

2. Add release notes, e.g. https://github.com/Qiskit/qiskit_sphinx_theme/releases/tag/1.11.0rc1
1. Add the sections `**Features / API Changes:**` and `**Bug Fixes:**`.
2. Use `git log --oneline` to see what changes have been made. Copy and paste those entries as bullets into the relevant sections. Ignore any "internal only" changes like CI changes or updates to the README.
3. Preview the release notes with the "Preview" tab.

It would be better to also have a proper changelog file in the repo. A main benefit is centralizing all the notes in one single place.

--

We probably do not need to use Reno for changelog generation. This repo is small and simple enough that manually maintaining a Markdown file is reasonable. Likely we should have PR authors update the changelog when making a change.

Relates to #214 - we need to figure out how to backport the changelog when backporting bug fixes.

@Eric-Arellano Eric-Arellano self-assigned this Mar 28, 2023
@Eric-Arellano Eric-Arellano removed their assignment Oct 18, 2023
@Eric-Arellano
Copy link
Collaborator Author

Going to close as low priority since this repo gets little traffic and few releases. Still a good idea to implement though if anyone wants to take it on.

@Eric-Arellano Eric-Arellano closed this as not planned Won't fix, can't repro, duplicate, stale Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: No status
Development

No branches or pull requests

1 participant