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 release notes link to changelog generation output #22

Open
mtreinish opened this issue Mar 31, 2022 · 1 comment
Open

Add release notes link to changelog generation output #22

mtreinish opened this issue Mar 31, 2022 · 1 comment

Comments

@mtreinish
Copy link
Member

We should have an option to include a link to the hosted release notes in the generated changelog output. The changlog output is just a subset of the git history for the release and the full release notes contain all the details. To do this we likely need a config flag somewhere to give qiskit-bot a hint to the url for the release notes and then it can generate the version suffix for the url to link to it.

@coruscating
Copy link

I was writing up an issue for this exact feature request until I found this. Perhaps the bot can use docs_url_prefix (from Qiskit/qiskit_sphinx_theme#321) in conf.py to generate the release notes URL automatically if the format for releases in general are docs_url_prefix/release_notes.html#release-notes-version (though I know Terra has a different anchor format).

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

No branches or pull requests

2 participants