changie
towncrier
Our great sponsors
changie | towncrier | |
---|---|---|
26 | 4 | |
582 | 728 | |
- | 1.2% | |
8.9 | 7.3 | |
5 days ago | 11 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.
- Looking for projects to contribute
- 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 Any Project
The full changelog for Changie, generated by Changie can be viewed on the website or on GitHub.
-
Good example projects to look through? + a good number of other questions - sorry
I did the first bullet point by passing a reference around, https://github.com/miniscruff/changie. The second bullet point is a little harder, cmd is sort of like a bin folder for scripts but as go files? In a way. I mostly use it cause that is what cobra defaults to. For the third one, besides speed and consistency it might be due to struct funcs when written using func (a *AStruct) doSomething() {} work both when passed in a pointer or value. Where as func (a AStruct) doSomething() {} only works when used on a value. The last point you can use errors.Is https://pkg.go.dev/errors#Is.
-
Open source Go projects to contribute (beginners)
A pretty simple CLI tool for handling changelogs and release notes, not a lot of issues at the moment though: https://github.com/miniscruff/changie.
-
Open source projects to contribute to
Self promo if you want to learn a CLI tool: https://github.com/miniscruff/changie
towncrier
-
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?
standard-version - :trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org
git-cliff - A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
ascii-image-converter - A cross-platform command-line tool to convert images into ascii art and print them on the console. Now supports braille art!
conventional-changelog-config-spec - a spec describing the config options supported by conventional-config for upstream tooling
nextrelease - One-click release publishing by merging an automated PR.
keploy - Test generation for Developers. Generate tests and stubs for your application that actually work!
go-zero - A cloud-native Go microservices framework with cli tool for productivity.
chigo - 🌈 Lolcat in Go: Rainbows and Unicorns!
core - Backend server API handling user mgmt, database, storage and real-time component
semver - Semantic Versioning Specification
clover - A lightweight document-oriented NoSQL database written in pure Golang.