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 changelog information to docs #434

Open
3 tasks
connortann opened this issue Feb 15, 2022 · 2 comments
Open
3 tasks

Add changelog information to docs #434

connortann opened this issue Feb 15, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@connortann
Copy link
Collaborator

connortann commented Feb 15, 2022

Many repos keep a changelog. Recommended practices / style are here: https://keepachangelog.com/en/1.0.0/

Suggested actions:

  • Add CHANGELOG.md to repo, in format detailed above
  • Key changes of past few releases populated
  • Include changelog into build documentation (e.g. markdown-to-RST extension here)
@connortann connortann added the documentation Improvements or additions to documentation label Feb 15, 2022
@connortann
Copy link
Collaborator Author

Maybe we could simply point people to the releases page?

https://github.com/bp/resqpy/releases

@connortann
Copy link
Collaborator Author

connortann commented Feb 16, 2022

A better solution would be to include the release information directly within the documentation. This seems doable:

  1. Could generate markdown text from GitHub Releases API, using this plugin:
    https://github.com/rhysd/changelog-from-release

  2. Could use this action to allow uploading of built artifacts into the ReadTheDocs process:
    https://github.com/dfm/rtds-action

  3. Enable parsing of Markdown files in Sphinx:
    https://www.sphinx-doc.org/en/1.5.3/markdown.html

@connortann connortann changed the title Add a changelog Add changelog information to docs Feb 16, 2022
@connortann connortann added the enhancement New feature or request label Feb 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant