helia icon indicating copy to clipboard operation
helia copied to clipboard

Update release process to better promote why a consumer should care

Open BigLep opened this issue 1 year ago • 2 comments

Done Criteria

The Helia process has a hook for maintainer-created content to highlight why someone should care about a release.

Why Important

As an example, https://github.com/ipfs/helia/pull/283 and https://github.com/ipfs/helia/releases/tag/helia-v2.1.0 don't make clear the significance of some of the changes (e.g., trustless gateway fallback, delegated routing endpoint we’re now using which hits IPNIs and DHT).

User/Customer

Consumers who are considering using or upgrading Helia

Notes

Ways I have seen this done other places in our ecosytem:

  1. Accompanying Blog post
  2. Changelog file where the human-readable text gets generated (and then having CI checks to ensure a PR has a changelog entry unless it was labeled to not a changelog entry.)

BigLep avatar Nov 06 '23 23:11 BigLep