Keep a Changelog

• semantic-pull-requests

  1 - -

* outside contributors get familiarized with the practice much faster (imagine getting new contributors to update changelogs)

We recently adopted this practice at Pyroscope and it's been working out pretty well for us [2], I can certainly recommend it.

[0] - https://github.com/apps/semantic-pull-requests

• conventional-changelog

  11 7,563 9.0 TypeScript

  Generate changelogs and release notes from a project's commit messages and metadata.

  

[1] - https://github.com/conventional-changelog/conventional-chang...

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• conventional-chang

  1 - -

[1] - https://github.com/conventional-changelog/conventional-chang...

• pyroscope

  56 7,382 9.6 Go

  Discontinued Continuous Profiling Platform. Debug performance issues down to a single line of code [Moved to: https://github.com/grafana/pyroscope] (by pyroscope-io)

  

• release-please

  46 4,125 8.6 TypeScript

  generate release PRs based on the conventionalcommits.org spec

  

Yep, I love this workflow.

We use release-please to automatically generate WIP "release PRs" so we can see the exact changelog (for a candidate release) drafted as merges come in.

[0] https://github.com/googleapis/release-please

• chronicle

  2 42 8.4 Go

  a fast changelog generator sourced from PRs and Issues (by anchore)

  

The approach I like to take is to curate issues and PR with semantic titles and organize them by label ("bug", "enhancement", etc) or linking PRs to an already curated issue. This way automation can use these to generate the changlog for me on each release based on closed issues and unlinked PRs since the last release.

We wrote Chronicle to do that automation for us: https://github.com/anchore/chronicle .

The nice thing about this... since you typically curate issues during the development process anyway, if you're doing that right then you get a nice looking changlog for free! We use this approach with our core tools, Syft and Grype (some changlog examples: https://github.com/anchore/syft/releases/tag/v0.31.0 and https://github.com/anchore/grype/releases/tag/v0.26.1 ).

Always happy to hear new feature ideas and possible customizations for Chronicle (put in an issue and let's chat )!

• syft

  32 5,451 9.8 Go

  CLI tool and library for generating a Software Bill of Materials from container images and filesystems

  

The approach I like to take is to curate issues and PR with semantic titles and organize them by label ("bug", "enhancement", etc) or linking PRs to an already curated issue. This way automation can use these to generate the changlog for me on each release based on closed issues and unlinked PRs since the last release.

We wrote Chronicle to do that automation for us: https://github.com/anchore/chronicle .

The nice thing about this... since you typically curate issues during the development process anyway, if you're doing that right then you get a nice looking changlog for free! We use this approach with our core tools, Syft and Grype (some changlog examples: https://github.com/anchore/syft/releases/tag/v0.31.0 and https://github.com/anchore/grype/releases/tag/v0.26.1 ).

Always happy to hear new feature ideas and possible customizations for Chronicle (put in an issue and let's chat )!

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• grype

  56 7,649 9.5 Go

  A vulnerability scanner for container images and filesystems

  

The approach I like to take is to curate issues and PR with semantic titles and organize them by label ("bug", "enhancement", etc) or linking PRs to an already curated issue. This way automation can use these to generate the changlog for me on each release based on closed issues and unlinked PRs since the last release.

We wrote Chronicle to do that automation for us: https://github.com/anchore/chronicle .

The nice thing about this... since you typically curate issues during the development process anyway, if you're doing that right then you get a nice looking changlog for free! We use this approach with our core tools, Syft and Grype (some changlog examples: https://github.com/anchore/syft/releases/tag/v0.31.0 and https://github.com/anchore/grype/releases/tag/v0.26.1 ).

Always happy to hear new feature ideas and possible customizations for Chronicle (put in an issue and let's chat )!

• traject

  1 99 4.2 Ruby

  An easy to use, high-performance, flexible and extensible metadata transformation system, focused on library-archives-museums input, and indexing to Solr as output.

  

I don't think I understand what "squashing PR branches" means (a github feature I haven't noticed?), but:

> The real benefit here is that Github puts the PR URL into the squashed commit message.

While not in the commit message, github will show you the PR a commit is part of in it's commit view regardless. Which I do find invaluable for tracing the documentation of a change, agreed! Not everyone knows about this feature (I don't think it's been there forever) in github UI.

Eg notice the `#279` included in this github commit UI display (the PR was, I'm pretty sure, not "squashed").

https://github.com/traject/traject/commit/10339e774e92e57f44...

• ESLint

  380 24,281 9.7 JavaScript

  Find and fix problems in your JavaScript code.

  

• bmlt-root-server

  2 12 6.8 PHP

  This is the Main Root Server Repo for the Basic Meeting List Toolbox

  

Suggest a related project