From 4ebc4eb03003aee3ea1908ab789b8516bbac6615 Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Tue, 5 Oct 2021 17:08:05 -0700 Subject: [PATCH 1/5] Updating release template based off some 0.10 learnings This addresses the easy items in https://github.com/ipfs/go-ipfs/issues/8248 --- docs/RELEASE_ISSUE_TEMPLATE.md | 37 ++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/docs/RELEASE_ISSUE_TEMPLATE.md b/docs/RELEASE_ISSUE_TEMPLATE.md index f69a172a429..035a92e8fd8 100644 --- a/docs/RELEASE_ISSUE_TEMPLATE.md +++ b/docs/RELEASE_ISSUE_TEMPLATE.md @@ -18,10 +18,6 @@ As usual, this release includes important fixes, some of which may be critical f < top highlights for this release notes > -## Changelog - -< changelog generated by bin/mkreleaselog > - ## ✅ Release Checklist For each RC published in each stage: @@ -54,8 +50,6 @@ Checklist: - [ ] **Stage 1 - Internal Testing** - [ ] CHANGELOG.md has been updated - use [`./bin/mkreleaselog`](https://github.com/ipfs/go-ipfs/tree/master/bin/mkreleaselog) to generate a nice starter list - - [ ] Network Testing: - - [ ] test lab things - TBD - [ ] Infrastructure Testing: - [ ] Deploy new version to a subset of Bootstrappers - [ ] Deploy new version to a subset of Gateways @@ -67,23 +61,19 @@ Checklist: - [ ] Upgrade to the RC in [ipfs-desktop](https://github.com/ipfs-shipyard/ipfs-desktop) and push to a branch ([example](https://github.com/ipfs/ipfs-desktop/pull/1826/commits/b0a23db31ce942b46d95965ee6fe770fb24d6bde)), and open a draft PR to track through the final release ([example](https://github.com/ipfs/ipfs-desktop/pull/1826)) - [ ] Ensure CI tests pass, repeat for new RCs - [ ] [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) - @lidel - - [ ] [NPM on IPFS](https://github.com/ipfs-shipyard/npm-on-ipfs) - @achingbrain - [ ] **Stage 2 - Community Dev Testing** - [ ] Reach out to the IPFS _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md) for testing this release (check when no more problems have been reported). If you'd like to be added to this list, please file a PR. - - [ ] Reach out to on IRC for beta testers. + - [ ] Reach out on Matrix for beta testers. - [ ] Run tests available in the following repos with the latest beta (check when all tests pass): - [ ] [orbit-db](https://github.com/orbitdb/orbit-db) - [ ] **Stage 3 - Community Prod Testing** - [ ] Documentation - [ ] Ensure that [CHANGELOG.md](https://github.com/ipfs/go-ipfs/tree/master/CHANGELOG.md) is up to date - [ ] Ensure that [README.md](https://github.com/ipfs/go-ipfs/tree/master/README.md) is up to date - - [ ] Ensure that all the examples we have produced for go-ipfs run without problems - [ ] Update docs by merging the auto-created PR in https://github.com/ipfs/ipfs-docs/pulls (they are auto-created every 12 hours) - - [ ] Invite the IPFS [_early testers_](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md) to deploy the release to part of their production infrastructure. - [ ] Invite the wider community through (link to the release issue): - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements) - - [ ] Twitter - - [ ] IRC + - [ ] Matrix - [ ] **Stage 4 - Release** - [ ] Final preparation - [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated. @@ -111,7 +101,24 @@ Checklist: - [ ] Make sure any last-minute changelog updates from the blog post make it back into the CHANGELOG. - [ ] Mark PR draft created for IPFS Desktop as ready for review. -## ❤️ Contributors + +## ⁉️ Do you have questions? + +The best place to ask your questions about IPFS, how it works and what you can do with it is at [discuss.ipfs.io](http://discuss.ipfs.io). We are also available at the `#ipfs` channel on Freenode, which is also [accessible through our Matrix bridge](https://riot.im/app/#/room/#freenode_#ipfs:matrix.org). + +## Release improvements for next time + +< Add any release improvements that were observed this cycle here so they can get incorporated into future releases. > + +## Items for a separate comment + +< Do these as a separate comment to avoid the main issue from getting too large and checkbox updates taking too long. > + +### Changelog + +< changelog generated by bin/mkreleaselog > + +### ❤️ Contributors < list generated by bin/mkreleaselog > @@ -122,7 +129,3 @@ Would you like to contribute to the IPFS project and don't know how? Well, there - Hack with IPFS and show us what you made! The All Hands call is also the perfect venue for demos, join in and show us what you built - Join the discussion at [discuss.ipfs.io](https://discuss.ipfs.io/) and help users finding their answers. - Join the [🚀 IPFS Core Implementations Weekly Sync 🛰](https://github.com/ipfs/team-mgmt/issues/992) and be part of the action! - -## ⁉️ Do you have questions? - -The best place to ask your questions about IPFS, how it works and what you can do with it is at [discuss.ipfs.io](http://discuss.ipfs.io). We are also available at the `#ipfs` channel on Freenode, which is also [accessible through our Matrix bridge](https://riot.im/app/#/room/#freenode_#ipfs:matrix.org). From ae446c60791b6d155098289bb381eb9caa2224a5 Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Thu, 7 Oct 2021 09:30:13 -0700 Subject: [PATCH 2/5] Further updates based on 2021-10-07 discussion. --- docs/RELEASE_ISSUE_TEMPLATE.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/docs/RELEASE_ISSUE_TEMPLATE.md b/docs/RELEASE_ISSUE_TEMPLATE.md index 035a92e8fd8..352ac75ceae 100644 --- a/docs/RELEASE_ISSUE_TEMPLATE.md +++ b/docs/RELEASE_ISSUE_TEMPLATE.md @@ -31,7 +31,7 @@ For each RC published in each stage: 4. Ask the infra team to update the DNSLink record for dist.ipfs.io to point to the new distribution. - cut a pre-release on [github](https://github.com/ipfs/go-ipfs/releases) and upload the result of the ipfs/distributions build in the previous step. - Announce the RC: - - [ ] On IRC/Matrix (both #ipfs and #ipfs-dev) + - [ ] On Matrix (both #ipfs and #ipfs-dev) - [ ] To the _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md). Checklist: @@ -61,12 +61,7 @@ Checklist: - [ ] Upgrade to the RC in [ipfs-desktop](https://github.com/ipfs-shipyard/ipfs-desktop) and push to a branch ([example](https://github.com/ipfs/ipfs-desktop/pull/1826/commits/b0a23db31ce942b46d95965ee6fe770fb24d6bde)), and open a draft PR to track through the final release ([example](https://github.com/ipfs/ipfs-desktop/pull/1826)) - [ ] Ensure CI tests pass, repeat for new RCs - [ ] [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) - @lidel -- [ ] **Stage 2 - Community Dev Testing** - - [ ] Reach out to the IPFS _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md) for testing this release (check when no more problems have been reported). If you'd like to be added to this list, please file a PR. - - [ ] Reach out on Matrix for beta testers. - - [ ] Run tests available in the following repos with the latest beta (check when all tests pass): - - [ ] [orbit-db](https://github.com/orbitdb/orbit-db) -- [ ] **Stage 3 - Community Prod Testing** +- [ ] **Stage 2 - Community Prod Testing** - [ ] Documentation - [ ] Ensure that [CHANGELOG.md](https://github.com/ipfs/go-ipfs/tree/master/CHANGELOG.md) is up to date - [ ] Ensure that [README.md](https://github.com/ipfs/go-ipfs/tree/master/README.md) is up to date @@ -74,7 +69,7 @@ Checklist: - [ ] Invite the wider community through (link to the release issue): - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements) - [ ] Matrix -- [ ] **Stage 4 - Release** +- [ ] **Stage 3 - Release** - [ ] Final preparation - [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated. - [ ] Merge `release-vX.Y.Z` into the `release` branch. From b7dca5323c011df620bd89493c6761aa962d2b14 Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Fri, 8 Oct 2021 15:17:26 -0700 Subject: [PATCH 3/5] Added OrbitDB to early testers. --- docs/EARLY_TESTERS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/EARLY_TESTERS.md b/docs/EARLY_TESTERS.md index 16d80f1fc82..d37a21a490b 100644 --- a/docs/EARLY_TESTERS.md +++ b/docs/EARLY_TESTERS.md @@ -31,6 +31,7 @@ We will ask early testers to participate at two points in the process: - [ ] Siderus (@koalalorenzo) - [ ] Charity Engine (@rytiss, @tristanolive) - [ ] Fission (@bmann) +- [ ] OrbitDB (@tabcat) ## How to sign up? From 6501c4aaecfbf75f1c198c17a9a4b981d35caec6 Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Fri, 8 Oct 2021 15:19:29 -0700 Subject: [PATCH 4/5] Fixing early tester username references. --- docs/EARLY_TESTERS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/EARLY_TESTERS.md b/docs/EARLY_TESTERS.md index d37a21a490b..c68d00453f4 100644 --- a/docs/EARLY_TESTERS.md +++ b/docs/EARLY_TESTERS.md @@ -22,7 +22,7 @@ We will ask early testers to participate at two points in the process: ## Who has signed up? -- [ ] pacman.store ([@RubenKelevra](https://github.com/RubenKelevra)) +- [ ] pacman.store (@RubenKelevra) - [ ] Infura (@MichaelMure) - [ ] Textile (@sanderpick) - [ ] Pinata (@obo20) From 91c292cc99e59931470806a7547a972c6dcb6b0d Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Fri, 8 Oct 2021 15:35:30 -0700 Subject: [PATCH 5/5] Being clear about how to contact early testers. --- docs/RELEASE_ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/RELEASE_ISSUE_TEMPLATE.md b/docs/RELEASE_ISSUE_TEMPLATE.md index 352ac75ceae..e375d49065c 100644 --- a/docs/RELEASE_ISSUE_TEMPLATE.md +++ b/docs/RELEASE_ISSUE_TEMPLATE.md @@ -32,7 +32,7 @@ For each RC published in each stage: - cut a pre-release on [github](https://github.com/ipfs/go-ipfs/releases) and upload the result of the ipfs/distributions build in the previous step. - Announce the RC: - [ ] On Matrix (both #ipfs and #ipfs-dev) - - [ ] To the _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md). + - [ ] To the _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md). Do this by copy/pasting their GitHub usernames and checkboxes as a comment so they get a GitHub notification. ([example](https://github.com/ipfs/go-ipfs/issues/8176#issuecomment-909356394)) Checklist: