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

Document the release process #170

Closed
Tracked by #196
BigLep opened this issue Feb 13, 2023 · 6 comments
Closed
Tracked by #196

Document the release process #170

BigLep opened this issue Feb 13, 2023 · 6 comments
Labels
topic/project-management Items related to organizing and managing this project well.

Comments

@BigLep
Copy link
Contributor

BigLep commented Feb 13, 2023

Done Criteria

It's clear for an outsider to understand:

  1. How often we release
  2. How they can track a release's progress
  3. The steps of a release
  4. Release owner

Why Important

"Clear is kind." This sets clear expectations for current and potential consumers. It also makes it clear for current/future maintainers on what is expected.

Notes

I expect work involved here will include:

  1. README update
  2. Release template md file we copy into each release issue
  3. Changelog md files

Given the main maintainers of this project are the Kubo maintainers and a major production consumer of this library is Kubo, I assume we'll have it follow the Kubo release cadence where we'd cut a new go-libipfs release shortly before a new Kubo RC.

@BigLep
Copy link
Contributor Author

BigLep commented Mar 7, 2023

2023-03-07 conversation:
Likely have steps around bubbling up to Kubo and Lotus for sanity checking.

@guseggert
Copy link
Contributor

I'd vote for cutting releases with Kubo, at the same time. Given the same folks maintain Kubo and go-libipfs, I think using the Kubo release + testing process to additionally test go-libipfs should be fine and will make go-libipfs releases more solid.

So then the release process would be to e.g. cut go-libipfs RC1 and use it in Kubo RC1, and then Kubo final release depends on the go-libipfs final release.

@BigLep
Copy link
Contributor Author

BigLep commented Mar 24, 2023

@guseggert : per verbal conversation, our changelog process is very important for this one. I believe rust-libp2p and now ipfs gateway conformance tests (ipfs/gateway-conformance#19 ) have mechanisms for actually driving releases from changelog (which puts emphasis on stewarding the changelog - good I think). Just passing on as something to consider.

@guseggert
Copy link
Contributor

guseggert commented Apr 5, 2023

Initial pass at documenting the release process: #266

Based on the process I followed for releasing v0.8.0

@guseggert
Copy link
Contributor

@guseggert : per verbal conversation, our changelog process is very important for this one. I believe rust-libp2p and now ipfs gateway conformance tests (ipfs/gateway-conformance#19 ) have mechanisms for actually driving releases from changelog (which puts emphasis on stewarding the changelog - good I think). Just passing on as something to consider.

For driving releases from changelog, I have opened #269 with details and done criteria. We need some more work on tooling to get this over the line.

@BigLep BigLep moved this from 🥞 Todo to 🏃‍♀️ In Progress in IPFS Shipyard Team Apr 6, 2023
@guseggert
Copy link
Contributor

@github-project-automation github-project-automation bot moved this from 🏃‍♀️ In Progress to 🎉 Done in IPFS Shipyard Team Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic/project-management Items related to organizing and managing this project well.
Projects
No open projects
Archived in project
Development

No branches or pull requests

2 participants