release-notes / release-notes Goto Github PK

12.0 3.0 0.0 8 KB

:tada::boom: Hosted changelog pages and release announcements for open source projects :boom::tada:

release-notes changelog release schema automation machine-processable

release-notes's Introduction

Release Notes

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

About

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.

Goal

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

What problem does this project solve?

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

Why should I care about release notes?

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.

Contribute

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

Project Repositories

release-notes's People

Contributors

Stargazers

Watchers

release-notes's Issues

Setting up github labels

As a project maintainer i need unified and sophisticated labels for all projects.

Source of inspiration: sane-github-labels

Introduce Taxonomy

As a developer i want to tag the modifications of a release to give them more context and to allow for filtering on them.

title: How Tagging may look like
description: >
  In order to give more context to a stated modification we could introduce
  some kind of optional changeset tagging.

releases:
  - version: Unreleased
    improved:
      - title: Adjust submit button color. 
        tags:
          - Android
          - UX
    fixed:
      - title: Fix some crash.
        tags:
          - iOS
    added:
      - Some fancy new feature.

This is great, I'd like to help and contribute

Dear Alrik,

I stumbled upon your release-notes project on Github by accident. I really like what you are trying to achieve here and fully support this initiative. I myself was actually looking for tools and thinking of writing some scripts to automate release-notes management for my react-native project. One of the goals I have there is that I want to manage my release notes in a human readable file, and yaml seems like a great fit. And then I want to be able to convert that file into a JSON file so I can include it in my react-native project. This seems quite trivial, but one of the challenges I face
is that I want to be able to generate two different JSON files, one for iOS and one for Android (sometimes bugs are fixed for specific platforms only). So I'd need to do some filtering on that.

Anyways, what I guess that I'm trying to say is, I'd like to help out, either by building tools or/and testing and verifying the ideas you propose.

best regards, Hein

How to structure packages for node, browser, react-native

This ticket is supposed to be a follow up for the following discussion:

@IjzerenHein
I just noticed that the lib is called "release-notes-node". Does this mean that it will only run in node? What I guess what I would like to see is that there is a generic lib which runs anywhere (browser, react-native, ..) and a node-js version which includes file-loading and such. What are you your thoughts on this?

@alrik
You are right, currently there is only one "reference implementation" in nodejs, but i'm quite open for splitting things up into separate modules in order to being able to support more platforms. Another way would be to either utilize browserify & babelify for generating a browser-compatible release-notes bundle or to implement a dedicated browser lib.

Delete "release note" ( or project )

I'd wanna delete my mistake spelled.
(especially, https://release-notes.com/release-notes/@jc01rho/tewt)

so delete feature is needed. :)