This is the cockpit repository of the release notes platform. 🚀 Here you'll find all resources around our platform, our vision and mission statement and how you can get involved .
🎉 Hosted changelog pages and release announcements for open source projects 🎉
📋 Lightweight release notes yml schema specification 📋
Cli tools for release notes management
https://release-notes.com

Release Notes is an open source platform for automated release notes management around traditional CHANGELOG files and our generalized Release Notes Schema Specification via CLI tools. Our node lib is the first implementation of the JSON schema definition that should make porting to other languages easy.

AND you can publish your CHANGELOG.md or release-notes.yml on our open source hub, that provides free hosted changelog pages for open source projects. We also have badges 🎉 and an API (at least one endpoint) 🎉

Check it out on https://release-notes.com.

The goal of the Release Notes project is to build a great ecosystem around releasing things.

Currently most of the open source projects out there do not provide details of what was added or what has changed when they release a new version.

Also there is no formal changelog/release notes standard and just a few best practise approaches out there.

Furthermore it is not possible to be informed about specific release details of the software you most likely build your business upon (like security updates, deprecations, minor releases and so on.)

Therefore we worked out an easy to use, human readable and machine processable schema for release notes. Around this spec we build open source tools to interact with release notes in order to:

• Automate release note management
• Manage release note update subscribtions of your dependencies
• Deliver fine grained notifications through the channels you already use
• Let your customers and/or dependents subscribe to your software updates
• Host community release notes in a hub

Release notes are the best way to manifest and communicate updates (eg. bug fixes, new release, new publication, etc.). Providing release notes makes it easy for other people to keep track on what has changed in your software.

Checkout our Awesome Changelog for a curated list of awesome CHANGELOG.md's and tools around release notes management.

Any contribution is welcome. This project is committed to the following CODE OF CONDUCT.

Open a ticket and

• give your feedback
• share your current painpoints about release notes
• star this project if you think its useful
• use the tools and report bugs
• request new features

Reach out by email

Send me an email at [email protected] and let's discuss how you can involve.

Submit a PR in order to

• fix a bug
• improve the docs
• improve test coverage

• Release Notes Specification
• Release Notes JSON-Schema Definitions
• Release Notes Node.js Reference Implementation
• Release Notes CLI
• Release Notes Hub
• Release Notes JS Coding Styles