Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
BigLep opened this issue Nov 6, 2023 · 2 comments
Open

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

BigLep opened this issue Nov 6, 2023 · 2 comments

Comments

@BigLep
Copy link
Contributor

BigLep commented Nov 6, 2023

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, #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
Copy link
Contributor Author

BigLep commented Nov 6, 2023

@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
Copy link
Member

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

2 participants