Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
x/pkgsite: surface module version release notes #42195
I review module release notes to decide whether I should upgrade a particular module now, later, or maybe never.
There is currently no standard way to represent release notes for module versions in the Go ecosystem (commit logs are a poor substitute for the first pass). Developers need to hunt around to work out how a particular module provides release notes (if at all). Eg:
Ideally there should be a simple, integrated way for module authors to make their release notes available on pkg.go.dev. For example, pkgsite currently integrates
Providing a standard way (eg, file/format) for describing module version changes via pkg.go.dev would incentivise the community to adopt a single standard. This would make it a little easier for developers to decide which module or module version they should use. Good release notes might even be considered an indicator of module health.
There already is a standard for changelog files, which we could piggyback on: https://keepachangelog.com/en/1.0.0/
If a project uses another form of changelog, such as GitHub Releases or a custom HTML page, we could simply link to the page instead of trying to understand or render the information.
I understand that GitHub Releases are perhaps more widespread than
Yes, I definitely think any changelog should be part of the module and not tied to a particular web service.
https://keepachangelog.com looks reasonable, but I couldn't see if it was commonly used somewhere. I left it out above since I think it's more important to have a standard way, than to have any specific standard (see