Update RELEASE_ISSUE_TEMPLATE.md
David Dias committed
Jul 12, 2019 at 16:26 UTC
63f6699037b86d66adc06e6c6f4fa0d9e8399999
1 file changed
+66
-2
docs/RELEASE_ISSUE_TEMPLATE.md
+66
-2
@@ -4,7 +4,11 @@
4
5
We're happy to announce go-ipfs X.Y.Z, bla bla...
6
7
-## Highlights
7
+## 🗺 What's left for release
8
+
9
+<List of items with PRs and/or Issues to be considered for this release>
10
+
11
+## 🔦 Highlights
12
13
< top highlights for this release notes >
14
@@ -12,7 +16,67 @@ We're happy to announce go-ipfs X.Y.Z, bla bla...
16
17
< changelog generated by bin/mkreleaselog >
18
15
-## Contributors
19
+## ✅ Release Checklist
20
+
21
+For each RC published in each stage:
22
+
23
+- version string in `version.go` has been updated
24
+- tag commit with vX.Y.Z-rcN
25
+- [ ] Stage 1 - Internal Testing
26
+ - [ ] Feature freeze. If any non-trivial features get added to the release, uncheck all the checkboxes and return to this stage.
27
+ - [ ] CHANGELOG.md has been updated
28
+ - use `./bin/mkreleaselog` to generate a nice starter list
29
+ - use `./doc/RELEASE_TEMPLATE.md` as a template
30
+ - [ ] Automated Testing (already tested in CI) - Ensure that all tests are passing, this includes:
31
+ - [ ] unit
32
+ - [ ] sharness
33
+ - [ ] [interop](https://github.com/ipfs/interop#test-with-a-non-yet-released-version-of-go-ipfs)
34
+ - [ ] go-ipfs-api
35
+ - [ ] go-ipfs-http-client
36
+ - [ ] Network Testing:
37
+ - [ ] test lab things
38
+ - [ ] Infrastructure Testing:
39
+ - [ ] Deploy new version to a subset of Bootstrappers
40
+ - [ ] Deploy new version to a subset of Gateways
41
+ - [ ] Deploy new version to a subset of Preload nodes
42
+ - [ ] Collect metrics every day. Work with the Infrastructure team to learn of any hiccup
43
+ - [ ] IPFS Application Testing - Run the tests of the following applications:
44
+ - [ ] WebUI
45
+ - [ ] IPFS Desktop
46
+ - [ ] IPFS Companion
47
+ - [ ] NPM on IPFS
48
+- [ ] Stage 2 - Public Beta
49
+ - [ ] Reach out to the IPFS _early testers_ listed in `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.
50
+ - [ ] Reach out to on IRC for beta testers.
51
+ - [ ] Run tests available in the following repos with the latest beta (check when all tests pass):
52
+ - [ ] [orbit-db](https://github.com/orbitdb/orbit-db)
53
+- [ ] Stage 3 - Soft Release
54
+ - [ ] Documentation
55
+ - [ ] Ensure that CHANGELOG.md is up to date
56
+ - [ ] Ensure that README.md is up to date
57
+ - [ ] Ensure that all the examples we have produced for go-ipfs run without problems
58
+ - [ ] Update HTTP-API Documentation on the Website using https://github.com/ipfs/http-api-docs
59
+ - [ ] Invite the IPFS _early testers_ to deploy the release to part of their production infrastructure.
60
+ - [ ] Invite the wider community through (link to the release issue):
61
+ - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)
62
+ - [ ] Twitter
63
+ - [ ] IRC
64
+- [ ] Stage 4 - Release
65
+ - [ ] Final preparation
66
+ - [ ] Verify that version string in `repo/version.go` has been updated
67
+ - [ ] tag commit with vX.Y.Z
68
+ - [ ] update release branch to point to release commit (`git merge vX.Y.Z`).
69
+ - [ ] publish dist.ipfs.io
70
+ - [ ] publish next version to https://github.com/ipfs/npm-go-ipfs
71
+ - [ ] Publish a Release Blog post (at minimum, a c&p of this release issue with all the highlights, API changes, link to changelog and thank yous)
72
+ - [ ] Broadcasting (link to blog post)
73
+ - [ ] Twitter
74
+ - [ ] IRC
75
+ - [ ] Reddit
76
+ - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)
77
+ - [ ] Announce it on the [IPFS Users mlist](https://groups.google.com/forum/#!forum/ipfs-users)
78
+
79
+## ❤️ Contributors
80
81
< list generated by bin/mkreleaselog >
82