Updating release template based off some 0.10 learnings (#8491)
* Updating release template based off some 0.10 learnings This addresses the easy items in https://github.com/ipfs/go-ipfs/issues/8248 * Further updates based on 2021-10-07 discussion. * Added OrbitDB to early testers. * Fixing early tester username references. * Being clear about how to contact early testers.
Steve Loeppky committed
Nov 23, 2021 at 11:32 UTC
ba2445ae72e3b9da4512fea75d2ae1fd59ef03d8
2 files changed
+25
-26
docs/EARLY_TESTERS.md
+2
-1
@@ -22,7 +22,7 @@ We will ask early testers to participate at two points in the process:
22
23
## Who has signed up?
24
25
-- [ ] pacman.store ([@RubenKelevra](https://github.com/RubenKelevra))
25
+- [ ] pacman.store (@RubenKelevra)
26
- [ ] Infura (@MichaelMure)
27
- [ ] Textile (@sanderpick)
28
- [ ] Pinata (@obo20)
@@ -31,6 +31,7 @@ We will ask early testers to participate at two points in the process:
31
- [ ] Siderus (@koalalorenzo)
32
- [ ] Charity Engine (@rytiss, @tristanolive)
33
- [ ] Fission (@bmann)
34
+- [ ] OrbitDB (@tabcat)
35
36
## How to sign up?
37
docs/RELEASE_ISSUE_TEMPLATE.md
+23
-25
@@ -18,10 +18,6 @@ As usual, this release includes important fixes, some of which may be critical f
18
19
< top highlights for this release notes >
20
21
-## Changelog
22
-
23
-< changelog generated by bin/mkreleaselog >
24
-
21
## ✅ Release Checklist
22
23
For each RC published in each stage:
@@ -35,8 +31,8 @@ For each RC published in each stage:
31
4. Ask the infra team to update the DNSLink record for dist.ipfs.io to point to the new distribution.
32
- 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.
33
- Announce the RC:
38
- - [ ] On IRC/Matrix (both #ipfs and #ipfs-dev)
39
- - [ ] To the _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md).
34
+ - [ ] On Matrix (both #ipfs and #ipfs-dev)
35
+ - [ ] 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))
36
37
Checklist:
38
@@ -54,8 +50,6 @@ Checklist:
50
- [ ] **Stage 1 - Internal Testing**
51
- [ ] CHANGELOG.md has been updated
52
- use [`./bin/mkreleaselog`](https://github.com/ipfs/go-ipfs/tree/master/bin/mkreleaselog) to generate a nice starter list
57
- - [ ] Network Testing:
58
- - [ ] test lab things - TBD
53
- [ ] Infrastructure Testing:
54
- [ ] Deploy new version to a subset of Bootstrappers
55
- [ ] Deploy new version to a subset of Gateways
@@ -67,24 +61,15 @@ Checklist:
61
- [ ] 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))
62
- [ ] Ensure CI tests pass, repeat for new RCs
63
- [ ] [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) - @lidel
70
- - [ ] [NPM on IPFS](https://github.com/ipfs-shipyard/npm-on-ipfs) - @achingbrain
71
-- [ ] **Stage 2 - Community Dev Testing**
72
- - [ ] 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.
73
- - [ ] Reach out to on IRC for beta testers.
74
- - [ ] Run tests available in the following repos with the latest beta (check when all tests pass):
75
- - [ ] [orbit-db](https://github.com/orbitdb/orbit-db)
76
-- [ ] **Stage 3 - Community Prod Testing**
64
+- [ ] **Stage 2 - Community Prod Testing**
65
- [ ] Documentation
66
- [ ] Ensure that [CHANGELOG.md](https://github.com/ipfs/go-ipfs/tree/master/CHANGELOG.md) is up to date
67
- [ ] Ensure that [README.md](https://github.com/ipfs/go-ipfs/tree/master/README.md) is up to date
80
- - [ ] Ensure that all the examples we have produced for go-ipfs run without problems
68
- [ ] Update docs by merging the auto-created PR in https://github.com/ipfs/ipfs-docs/pulls (they are auto-created every 12 hours)
82
- - [ ] 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.
69
- [ ] Invite the wider community through (link to the release issue):
70
- [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)
85
- - [ ] Twitter
86
- - [ ] IRC
87
-- [ ] **Stage 4 - Release**
71
+ - [ ] Matrix
72
+- [ ] **Stage 3 - Release**
73
- [ ] Final preparation
74
- [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated.
75
- [ ] Merge `release-vX.Y.Z` into the `release` branch.
@@ -111,7 +96,24 @@ Checklist:
96
- [ ] Make sure any last-minute changelog updates from the blog post make it back into the CHANGELOG.
97
- [ ] Mark PR draft created for IPFS Desktop as ready for review.
98
114
-## ❤️ Contributors
99
+
100
+## ⁉️ Do you have questions?
101
+
102
+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).
103
+
104
+## Release improvements for next time
105
+
106
+< Add any release improvements that were observed this cycle here so they can get incorporated into future releases. >
107
+
108
+## Items for a separate comment
109
+
110
+< Do these as a separate comment to avoid the main issue from getting too large and checkbox updates taking too long. >
111
+
112
+### Changelog
113
+
114
+< changelog generated by bin/mkreleaselog >
115
+
116
+### ❤️ Contributors
117
118
< list generated by bin/mkreleaselog >
119
@@ -122,7 +124,3 @@ Would you like to contribute to the IPFS project and don't know how? Well, there
124
- 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
125
- Join the discussion at [discuss.ipfs.io](https://discuss.ipfs.io/) and help users finding their answers.
126
- Join the [🚀 IPFS Core Implementations Weekly Sync 🛰](https://github.com/ipfs/team-mgmt/issues/992) and be part of the action!
125
-
126
-## ⁉️ Do you have questions?
127
-
128
-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).