ipfs / helia

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

Document the release process / expectations #81

Open BigLep opened 1 year ago

BigLep commented 1 year ago

Done Criteria

We have a durablble document that covers Helia's release philosophy and mechanics, and is easily discoverable.

Why Important

Releases are our delivery mechanism for translating the great development work into a form that consumers can easily use. We want it documented:

  1. for resieliency so we're not reliant on tribal knowledge
  2. helps build confidence and set expectations for consumers
  3. gives insights to other contributors

Notes

Specific steps I assume we'll need to take:

Questions I think the doc needs to answer:

I know I'm throwing a lot here. I do think it's better for us to get something going that we progressively add to than nothing.

Potentially related documents to draw from that answers a lot of the questions above for their context:

  1. Boxo: https://github.com/ipfs/boxo/issues/170
  2. Kubo release process: https://pl-strflt.notion.site/Kubo-Release-Process-5a5d066264704009a28a79cff93062c4
  3. Kubo release steps: https://github.com/ipfs/kubo/blob/master/docs/RELEASE_ISSUE_TEMPLATE.md
2color commented 5 months ago

I've kicked this off with an initial stab in the wiki https://github.com/ipfs/helia/wiki/Development-and-Release-Process