search

ipfs / helia

An implementation of IPFS in JavaScript
https://helia.io
Other
916 stars 99 forks source link

Update release process to better promote why a consumer should care #304

Open BigLep opened 11 months ago

BigLep commented 11 months ago

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 commented 11 months ago

@ipfs/helia-dev : I know this was brought up in https://pl-strflt.notion.site/2023-11-02-Helia-Working-Group-bc5037101e0a4f2c8053fe679c1e1618?pvs=4 . Did we land somewhere?

SgtPooki commented 7 months ago

I'm not sure we have the bandwidth to do much more than what is already automated. We do have the Wiki where we can add some documentation, and I think discussion forums (discuss.ipfs.tech) could be where we post information about important releases.

@lidel @aschmahmann Is there something further you two would like to see done here?