towncrier
skillmap
| towncrier | skillmap | |
|---|---|---|
| 5 | 2 | |
| 733 | 106 | |
| 0.8% | - | |
| 7.6 | 0.0 | |
| 5 days ago | about 2 years ago | |
| Python | Python | |
| MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
towncrier
-
Changelog-Driven Releases
I don't really like writing the change log automatically from commits. I think those both have a slightly different audience and thus need different wording.
I know the frustration of merge conflicts on the change log file.
Right now, I'm creating change logs by hand which is time consuming to do on release time. I'm considering switching to using towncrier or something similar, where you have a changes dir with one file per change for creating change logs --> https://towncrier.readthedocs.io/
-
towncrier VS cf_changelog - a user suggested alternative
2 projects | 10 Jan 2024
-
What are some examples of good release notes from open source projects that you have come across?
Here is an example of another decent one. Not perfect, but it is generated with TownCrier, so it is easy to maintain.
-
The Subtle Art of the Changelog
We used to... somewhat attempt manual changelogs. Every time it came to a release the release manager would ask around for what the key changes were, and we usually ended up with only a couple of entries.
Now, we use https://github.com/twisted/towncrier . Every change goes through pull requests, and every PR must have a newsfragment file - and we enforce this with a test that fails if it isn't present (with convenience functions of rewriting the number to match the PR if you name the news file XXX.{category}). If it's not a user-facing change, then we just have a category that is ignored.
On releases (or on individual PRS along the way), the release manager generates the changelog, but also edits them into a relatively coherent style (or rewrites developers news fragments along the way).
Every change has a note written aimed at the user. Every entry in the changelog has a link to the relevant PR or commit. We have much better changelogs now.
-
Changie - Automated Changelog Tool
Twisted's Town Crier is a generic tool
skillmap
What are some alternatives?
standard-version - :trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org
glumpy - Python+Numpy+OpenGL: fast, scalable and beautiful scientific visualization
changie - Automated changelog tool for preparing releases with lots of customization options
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.
conventional-changelog-config-spec - a spec describing the config options supported by conventional-config for upstream tooling
bokeh - Interactive Data Visualization in the browser, from Python
nextrelease - One-click release publishing by merging an automated PR.
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
semver - Semantic Versioning Specification
pyscaffold - 🛠Python project template generator with batteries included
keep-a-changelog - If you build software, keep a changelog.
pyproject - CLI tool to setup python packages