{"id":13798477,"url":"https://github.com/release-notes/release-notes-spec","last_synced_at":"2025-05-13T05:32:17.558Z","repository":{"id":135959270,"uuid":"96366298","full_name":"release-notes/release-notes-spec","owner":"release-notes","description":"The goal of this repository is to work out an easy to use, human readable and machine processable schema for release notes.","archived":true,"fork":false,"pushed_at":"2017-10-30T17:30:25.000Z","size":23,"stargazers_count":8,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2024-02-14T04:33:36.819Z","etag":null,"topics":["changelog","machine-processable","release","release-notes","schema","specification"],"latest_commit_sha":null,"homepage":"https://github.com/release-notes/release-notes","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/release-notes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-07-05T22:30:16.000Z","updated_at":"2024-02-14T04:33:36.819Z","dependencies_parsed_at":null,"dependency_job_id":"9e5dde84-eefe-4b9c-8f5c-2e0692157fcf","html_url":"https://github.com/release-notes/release-notes-spec","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-notes%2Frelease-notes-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-notes%2Frelease-notes-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-notes%2Frelease-notes-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-notes%2Frelease-notes-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/release-notes","download_url":"https://codeload.github.com/release-notes/release-notes-spec/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253883131,"owners_count":21978611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["changelog","machine-processable","release","release-notes","schema","specification"],"created_at":"2024-08-04T00:00:44.555Z","updated_at":"2025-05-13T05:32:17.142Z","avatar_url":"https://github.com/release-notes.png","language":null,"readme":"# Release Notes Schema Specification\n\n[![Subscribe to Release Notes](https://release-notes.com/badges/v1.svg)](https://release-notes.com/@release-notes/release-notes-spec)\n\n## About\n\nThe goal of this repository is to work out an **easy to use**,\n**human readable** and **machine processable** YAML schema specification for release notes.\n\n## The Specification\n\nThe key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119).\n\nThe release notes MUST be defined in a `release-notes.yml` file on project root.\n\nThe format of that file MUST be [YAML](http://www.yaml.org/spec/1.2/spec.html).\n\nThe document MUST provide a **title**.\n\nThe document SHOULD provide a **description**.\n\nThe document MUST prodive **releases**, an array of `ReleaseDetails`.\n\nThe releases SHOULD be ordered, the latest release comes first.\n\nA release MUST provide a **version**.\n\nA release MUST provide a **date** of type `ISODate` or `ISODateTime`.\n\nA release MAY provide a **title**.\n\nA release SHOULD provide a **description**.\n\n### The Upcoming Release\n\nAn upcoming release MUST have the version set to `Unreleased`,\n`Next` or `Upcoming`.\n\nThe upcoming release MAY omit the **date** info.\n\n### Modification Types\n\nA release MAY provide a list of **added** functionality.\n\nA release MAY provide a list of **removed** functionailty.\n\nA release MAY provide a list of **changed** functionailty.\n\nA release MAY provide a list of **improved** functionality.\n\nA release MAY provide a list of **deprecated** functionality.\n\nA release MAY provide a list of **fixed** functionality.\n\nA release MAY provide a list of **secured** fixes.\n\nAll modification list items MUST be either string or an object with a\n**title** property.\n\n### Tags\n\nA modification in object notation MAY provide a list of **tags**.\nEach tag MUST be a string that SHOULD be treated case insensitive.\n\n\n## Example\n\n```yaml\ntitle: Release Notes of an awesome project\ndescription: \u003e\n  Awesome project makes your cli a better place.\n\nreleases:\n- version: Unreleased\n  added:\n  - Add more fancy stuff.\n  deprecated:\n  - Deprecate some \"not so awesome\" command.\n- version: 0.1.1\n  date: 2017-10-30\n  fixed:\n  - title: Do not crash on win32.\n    tags: [\"Windows\"]\n- version: 0.1.0\n  date: 2017-10-30\n  description: The first release\n  added:\n  - Introduce some awesomeness.\n```\n\n## Project Repositories\n\nThe Release Notes project consists of the following repositories:\n   \n- [Release Notes Hub](https://github.com/release-notes/release-notes-hub)\n- [Release Notes CLI Tool](https://github.com/release-notes/release-notes-cli)\n- [Release Notes Node.js lib](https://github.com/release-notes/release-notes-node)\n- [Release Notes Specification](https://github.com/release-notes/release-notes-spec)\n- [Release Notes JSON-Schema Definitions](https://github.com/release-notes/release-notes-schema)\n\n---\n\n### LICENSE\n\nThe files in this archive are released under MIT license.\nYou can find a copy of this license in [LICENSE](LICENSE).\n","funding_links":[],"categories":["Formats"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelease-notes%2Frelease-notes-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelease-notes%2Frelease-notes-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelease-notes%2Frelease-notes-spec/lists"}