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.

Sign up for GitHub

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

Jump to bottom

Use Town Crier to manage changelog #94

Open
kdeldycke opened this issue Nov 6, 2021 · 2 comments
Open

Use Town Crier to manage changelog #94

kdeldycke opened this issue Nov 6, 2021 · 2 comments
Labels
🆙 changelog Keep track of changes 📚 documentation Update to non-code (readme, docstrings, typos, …) 🎁 feature request Not existing yet and need to be implemented

Comments

@kdeldycke
Copy link
Owner

It seems there is a way to produce Markdown changelogs with towncrier. See: twisted/towncrier#128

This might be helpful to manage version fragments, and have them in sync between:

  • Sphinx docs
  • GitHub releases
  • Copies in Readme showing delta-changes
@kdeldycke kdeldycke transferred this issue from kdeldycke/meta-package-manager Jan 11, 2022
@kdeldycke kdeldycke added 🎁 feature request Not existing yet and need to be implemented 🆙 changelog Keep track of changes 📚 documentation Update to non-code (readme, docstrings, typos, …) labels Jan 11, 2022
@kdeldycke
Copy link
Owner Author

Producing Markdown with TownCrier has been documented at: https://towncrier.readthedocs.io/en/latest/markdown.html

Refs twisted/towncrier#128 and twisted/towncrier#436

@kdeldycke
Copy link
Owner Author

Also look at: https://github.com/callowayproject/generate-changelog

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🆙 changelog Keep track of changes 📚 documentation Update to non-code (readme, docstrings, typos, …) 🎁 feature request Not existing yet and need to be implemented
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kdeldycke