keep-a-changelog VS Release It! 🚀

A style guide for changelogs, adapted from and a stricter subset of [Keep a Changelog](https://keepachangelog.com/)

not entirely related to your question, but worth a read : https://keepachangelog.com/

A Changelog should be written for each release, conforming to the standard https://keepachangelog.com/

I agree, I used to have a NEWS file in my projects (later a NEWS.md), but as others commented, the signification of the term "changelog" has changed. Sites like https://keepachangelog.com/ really refers to release notes or news.

Overall I like the format and advice from https://keepachangelog.com/

We’ve adopted it at work and it’s nice to have a consistent format that is relatively noise free.

You can read more about it at: https://keepachangelog.com/

# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [0.0.4] - 2014-08-09 ### Added - Better explanation of the difference between the file ("CHANGELOG") and its function "the change log". ### Changed - Refer to a "change log" instead of a "CHANGELOG" throughout the site to differentiate between the file and the purpose of the file — the logging of changes. ### Removed - Remove empty sections from CHANGELOG, they occupy too much space and create too much noise in the file. People will have to assume that the missing sections were intentionally left out because they contained no notable changes. ## [0.0.3] - 2014-08-09 ### Added - "Why should I care?" section mentioning The Changelog podcast. ## [0.0.2] - 2014-07-10 ### Added - Explanation of the recommended reverse chronological release ordering. ## [0.0.1] - 2014-05-31 ### Added - This CHANGELOG file to hopefully serve as an evolving example [Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...HEAD [0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4 [0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3 [0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2 [0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1

Open source libraries and frameworks share a common necessity: the need to develop multiple packages cohesively and efficiently while managing their versioning and publishing to NPM. Nx has emerged as a go-to choice for handling such open source monorepos (as we'll explore further in the next section of this blog post). Until recently, one area Nx did not address directly was versioning and release management. Traditionally, this gap has been filled with tools like release-it, changesets, or custom Node scripts, similar to our approach in the Nx repository.

Hi. I'm maintaining a small monorepo and I'd like to learn techniques from large, mature projects like typescript-eslint. I assume they automate changelogs from commit logs and/or PRs, but I can't figure out how they do it by looking at their source code. I do know of tools like release-it that helps automate the process; do the typescript-eslint maintainers use such a tool, or use a homegrown one?

This is a quick start guide for setting up a NestJS project for creating your own package library with automated versioning and package publishing. https://github.com/Emgevorgyan/nestjs-package-quick-start

Release It! - This seems promising. A CLI tool that can be used in interactive or continuous integration mode. The big appeal for me is a Yarn workspaces specific plugin.

Fine, but I need a package release tool and release-it tools looks good. I install, configure and on the last step - publishing - I find out that this lib does not support monorepo... https://github.com/release-it/release-it/issues/831 and the release-it-yarn-workspaces lib does not support the latest version of release-it https://github.com/rwjblue/release-it-yarn-workspaces/issues/68

May be less relevant for your particular workflow (because npm-specific and because everything is internal for you), but I’m a big fan of an alternative in the auto-release-generation space: the combo of release-it and release-it-lerna-changelog, which give you the same kind of automation but don’t require specific git commit messages, because instead the combo uses the GH API and labels to generate the changelog. This is a muuuuuch nicer experience for external contributors, because it puts the responsibility for that back on maintainers instead.

Release It - To create tags, bump the versions, manage release betas and detect merged changes.

Release It