changie
towncrier
changie | towncrier | |
---|---|---|
26 | 5 | |
779 | 842 | |
1.2% | 1.3% | |
8.5 | 9.0 | |
4 days ago | 8 days ago | |
Go | 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.
changie
-
Changie - Auto mode and GitHub action
That is all for now. Reach me on twitter @miniScruffDev or by starting a discussion on GitHub.
-
Looking for feedback: cargo-changelog
Yes, there is changie - a golang tool that inspired me actually.
-
Documentation generated from Code with custom options
The complete source for this generation is here in gen.go and might help anyone else who wants to implement there own docs from code.
- Looking for projects to contribute
- Changie
- Any open source project I could join?
- Looking for open source project to contribute
-
Changie - Replacments and Choices
A short example is the one from Changie itself that asks for an issue number and adds a link when formatting. Changie's .changie.yaml is basically the default configuration with the issue choice added.
-
Changie - Automated Changelog Generation for Large Projects
That is all for now. Reach me on twitter @miniScruffDev or by starting a discussion on GitHub.
-
Running a method in the top-level scope of a Go program
I tend to create a package or file for handling configs with a load or init method depending on how it is loaded ( yaml or env vars ). Here is a bigger example for my own CLI tool Changie https://github.com/miniscruff/changie/blob/main/core/config.go.
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
What are some alternatives?
git-cliff - A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
standard-version - :trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org
core - Backend server API handling user mgmt, database, storage and real-time component
nextrelease - One-click release publishing by merging an automated PR.
keploy - Unit, API & Integration Testing Agent for Developers. Generate tests, mocks/stubs for your APIs that actually work!
keep-a-changelog - If you build software, keep a changelog.