Update releases.md
David Dias committed
Jul 12, 2019 at 16:25 UTC
a32d5e973440c957e535ebb072842e53a9108228
1 file changed
+5
-84
docs/releases.md
+5
-84
@@ -24,14 +24,12 @@ We might expand the six week release schedule in case of:
24
Before this stage, we expect _all_ tests (interop, testlab, performance, etc.) to pass.
25
26
At this stage, we'll:
27
-
28
-1. Start a partial-rollout to our own infrastructure.
29
-2. Test against ipfs and ipfs-shipyard applications.
27
+- 1. Start a partial-rollout to our own infrastructure.
28
+- 2. Test against ipfs and ipfs-shipyard applications.
29
30
**Goal(s):**
32
-
33
-1. Make sure we haven't introduced any obvious regressions.
34
-2. Test the release in an environment we can monitor and easily roll back (i.e., our own infra).
31
+- 1. Make sure we haven't introduced any obvious regressions.
32
+- 2. Test the release in an environment we can monitor and easily roll back (i.e., our own infra).
33
34
### Stage 2 - Public Beta
35
@@ -55,84 +53,7 @@ At this stage, the release is "battle hardened" and ready for wide deployment.
53
54
## Performing a Release
55
58
-The first step is for the `Lead Maintainer` for `go-ipfs` to open an issue with Title `go-ipfs <version> Release` and a c&p of the following template:
59
-
60
-```
61
-> <short tl;dr; of the release>
62
-
63
-# 🗺 What's left for release
64
-
65
-<List of items with PRs and/or Issues to be considered for this release>
66
-
67
-# 🔦 Highlights
68
-
69
-<List of items with PRs and/or Issues included for this release>
70
-
71
-# 🏗 API Changes
72
-
73
-<List of API changes, if any>
74
-
75
-# ✅ Release Checklist
76
-
77
-For each RC published in each stage:
78
-
79
-- version string in `version.go` has been updated
80
-- tag commit with vX.Y.Z-rcN
81
-
82
-- [ ] Stage 1 - Internal Testing
83
- - [ ] Feature freeze. If any non-trivial features get added to the release, uncheck all the checkboxes and return to this stage.
84
- - [ ] CHANGELOG.md has been updated
85
- - use `./bin/mkreleaselog` to generate a nice starter list
86
- - use `./doc/RELEASE_TEMPLATE.md` as a template
87
- - [ ] Automated Testing (already tested in CI) - Ensure that all tests are passing, this includes:
88
- - [ ] unit
89
- - [ ] sharness
90
- - [ ] [interop](https://github.com/ipfs/interop#test-with-a-non-yet-released-version-of-go-ipfs)
91
- - [ ] go-ipfs-api
92
- - [ ] go-ipfs-http-client
93
- - [ ] Network Testing:
94
- - [ ] test lab things
95
- - [ ] Infrastructure Testing:
96
- - [ ] Deploy new version to a subset of Bootstrappers
97
- - [ ] Deploy new version to a subset of Gateways
98
- - [ ] Deploy new version to a subset of Preload nodes
99
- - [ ] Collect metrics every day. Work with the Infrastructure team to learn of any hiccup
100
- - [ ] IPFS Application Testing - Run the tests of the following applications:
101
- - [ ] WebUI
102
- - [ ] IPFS Desktop
103
- - [ ] IPFS Companion
104
- - [ ] NPM on IPFS
105
-- [ ] Stage 2 - Public Beta
106
- - [ ] 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.
107
- - [ ] Reach out to on IRC for beta testers.
108
- - [ ] Run tests available in the following repos with the latest beta (check when all tests pass):
109
- - [ ] [orbit-db](https://github.com/orbitdb/orbit-db)
110
-- [ ] Stage 3 - Soft Release
111
- - [ ] Documentation
112
- - [ ] Ensure that CHANGELOG.md is up to date
113
- - [ ] Ensure that README.md is up to date
114
- - [ ] Ensure that all the examples we have produced for go-ipfs run without problems
115
- - [ ] Update HTTP-API Documentation on the Website using https://github.com/ipfs/http-api-docs
116
- - [ ] Invite the IPFS _early testers_ to deploy the release to part of their production infrastructure.
117
- - [ ] Invite the wider community through (link to the release issue):
118
- - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)
119
- - [ ] Twitter
120
- - [ ] IRC
121
-- [ ] Stage 4 - Release
122
- - [ ] Final preparation
123
- - [ ] Verify that version string in `repo/version.go` has been updated
124
- - [ ] tag commit with vX.Y.Z
125
- - [ ] update release branch to point to release commit (`git merge vX.Y.Z`).
126
- - [ ] publish dist.ipfs.io
127
- - [ ] publish next version to https://github.com/ipfs/npm-go-ipfs
128
- - [ ] 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)
129
- - [ ] Broadcasting (link to blog post)
130
- - [ ] Twitter
131
- - [ ] IRC
132
- - [ ] Reddit
133
- - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)
134
- - [ ] Announce it on the [IPFS Users mlist](https://groups.google.com/forum/#!forum/ipfs-users)
135
-```
56
+The first step is for the `Lead Maintainer` for `go-ipfs` to open an issue with Title `go-ipfs <version> Release` and a c&p of the [RELEASE_ISSUE_TEMPLATE](./RELEASE_ISSUE_TEMPLATE.md)
57
58
## Release Version Numbers (aka semver)
59