Changelogs are important assets that describe a release and its contents. release.software does not introduce a new lexicon to represent a changelog; instead, we adopt the existing standard.site initiative to allow users to compose changelogs using their tools of choice.
Publishing Markdown
To publish Markdown changelogs—for example in automated, LLM-written workflows—we recommend you publish a site.standard.document utilizing markpub.at for content.
Changelog types
Primary
The software.release.version record can link outwards to a site.standard.document at creation time. This should be treated as the "canonical" changelog; it does not need to be published by the same DID as the project owner.
Secondary
For workflows that involve writing the changelog after cutting the version, changelogs can be linked to a release later using the site.standard.document#links field. Apps that wish to display changelogs can use a service such as Constellation to retrieve changelogs based on the version's AT URI.
This workflow allows more than just changelogs to be associated with a release. Announcement blog posts, support documents, and more can be linked back to a release in this fashion.