@cryptotaxi247 / kubo / commits / 9bb15f232

releases: switch to a soft release model

And other nits.

Steven Allen committed Jul 11, 2019 at 00:21 UTC 9bb15f232f14220c587f33d71e7a6a159d4149ba

2 files changed +117 -97

docs/RELEASE_TEMPLATE.md new

+27

@@ -0,0 +1,27 @@

1 +# Go-IPFS Changelog Template

2 +

3 +## X.Y.Z YYYY-MM-DD

4 +

5 +We're happy to announce go-ipfs X.Y.Z, bla bla...

6 +

7 +< release notes >

8 +

9 +### Contributors

10 +

11 +< list generated by bin/mkreleaselog >

12 +

13 +Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started:

14 +

15 +- Check the issues with the `help wanted` label in the [go-ipfs repo](https://github.com/ipfs/go-ipfs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)

16 +- Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt/#weekly-ipfs-all-hands

17 +- 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

18 +- Join the discussion at http://discuss.ipfs.io/ and help users finding their answers.

19 +- Join the [Go Core Dev Team Weekly Sync](https://github.com/ipfs/team-mgmt/issues/650) and be part of the Sprint action!

20 +

21 +### ⁉️ Do you have questions?

22 +

23 +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).

24 +

25 +### Changelog

26 +

27 +< changelog generated by bin/mkreleaselog >

docs/releases.md

+90 -97

@@ -9,7 +9,7 @@

10 ## Release Philosophy

12 -`go-ipfs` aims to have release every six weeks, two releases per quarter. During these 6 week releases, we go through 4 different stages of Release Candidates (RC) that gives us the opportunity to test the new version against our test environments (unit, interop, integration), QA in our current production environment, IPFS apps (e.g. Desktop and WebUI) and with our _early testers_[1] that have IPFS running in Production, by leveraging their own test infrastructure and QA systems.

12 +`go-ipfs` aims to have release every six weeks, two releases per quarter. During these 6 week releases, we go through 4 different stages that gives us the opportunity to test the new version against our test environments (unit, interop, integration), QA in our current production environment, IPFS apps (e.g. Desktop and WebUI) and with our community and _early testers_[1] that have IPFS running in Production.

14 We might expand the six week release schedule in case of:

15 - No new updates to be added

@@ -17,20 +17,41 @@ We might expand the six week release schedule in case of:

18 ## Release Flow

20 -`go-ipfs` releases come in 4 stages:

20 +`go-ipfs` releases come in 4 stages designed to gradually roll out changes and reduce the impact of any regressions that may have been introduced. If we need to merge non-trivial features/fixes during the process, we start over at stage 1.

22 -- **Release Stage 1 - Internal testing** - Test the Release against our testing infrastructure, including interoperability, integration, test lab, multiple runtimes and the apps we've built (WebUI, Desktop, NPM on IPFS, HTTP Client Libraries). The intent is to make this stage fully automated (and somewhat is already), until then, we manually check a list and ensure that all tests have been run

23 -- **Release Stage 2 - Invite _early testers_ to try it out** - Reach out to our _early testers_ (i.e. projects that have volunteered to support `go-ipfs` by using their own test infrastructure and tell us the results)

24 -- **Release Stage 3 - Announce to the broader community** - Communicate to the community that a new Release Candidate is ready and that everyone is welcome to test it with us

25 -- **Release Stage 4 - Complete the Release** - Finalize the release, start the next release.

22 +### Stage 1 - Internal Testing

27 -The Release Stages are not linked to Release Candidate numbers, in fact, there can be multiple release candidate per stages as we catch bugs and improve the release itself.

24 +Before this stage, we expect _all_ tests (interop, testlab, performance, etc.) to pass.

29 -

30 - <a href="https://ipfs.io">

31 - <img src="https://gateway.ipfs.io/ipfs/QmaFtLxoCAm5vFQ9AftKkhJwSAdDdF1jzV9DfzW6gbXqFL/Paper.Sketches.23.png" width="450" />

32 - </a>

33 -

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.

30 +

31 +**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).

35 +

36 +### Stage 2 - Public Beta

37 +

38 +At this stage, we'll announce the impending release to the community and ask for beta testers.

39 +

40 +**Goal:** Test the release in as many non-production environments as possible. This is relatively low-risk but gives us a _breadth_ of testing internal testing can't.

41 +

42 +### Stage 3 - Soft Release

43 +

44 +At this stage, we consider the release to be "production ready" and ask will ask the community and our early testers to (partially) deploy the release to their production infrastructure.

45 +

46 +**Goal(s):**

47 +

48 +1. Test the release in some production environments with heavy workloads.

49 +2. Partially roll-out an upgrade to see how it affects the network.

50 +3. Retain the ability to ship last-minute fixes before the final release.

51 +

52 +### Stage 4 - Release

53 +

54 +At this stage, the release is "battle hardened" and ready for wide deployment.

56 ## Performing a Release

@@ -54,91 +75,63 @@ The first step is for the `Lead Maintainer` for `go-ipfs` to open an issue with

75 # ✅ Release Checklist

77 For each RC published in each stage:

57 -- [ ] version string in `version.go` has been updated

58 -- [ ] tag commit with vX.Y.Z-rcN

59 -

60 -### Release Stage 1 - Internal testing

61 -

62 -When Release Stage 1, there is a features freeze for the release branch.

63 -

64 -- [ ] CHANGELOG.md has been updated

65 - - use `./bin/mkreleaselog` to generate a nice starter list

66 -- [ ] Automated Testing - Ensure that all tests are passing, this includes:

67 - - [ ] unit

68 - - [ ] sharness

69 - - [ ] [interop](https://github.com/ipfs/interop#test-with-a-non-yet-released-version-of-go-ipfs)

70 -- [ ] Network Testing:

71 - - [ ] test lab things

72 -- [ ] Infrastructure Testing:

73 - - [ ] Deploy new version to a subset of Bootstrappers

74 - - [ ] Deploy new version to a subset of Gateways

75 - - [ ] Deploy new version to a subset of Preload nodes

76 - - [ ] Collect metrics every day. Work with the Infrastructure team to learn of any hiccup

77 -- [ ] IPFS HTTP Client Libraries Testing:

78 - - [ ] [JS](http://github.com/ipfs/js-ipfs-http-client)

79 - - [ ] [Go](https://github.com/ipfs/go-ipfs-api)

80 -- [ ] IPFS Application Testing - Run the tests of the following applications:

81 - - [ ] WebUI

82 - - [ ] IPFS Desktop

83 - - [ ] IPFS Companion

84 - - [ ] NPM on IPFS

85 -

86 -### Release Stage 2 - Invite _early testers_ to try it out

87 -

88 -- [ ] Reach out to the IPFS _early testers_ listed below for testing this release (check when no more problems have been reported).

89 - - [ ] **COPY THE LIST FROM `docs/EARLY_TESTERS.md`**

90 -- [ ] Run tests available in the following repos with the latest RC (check when all tests pass):

91 - - [ ] [orbit-db](https://github.com/orbitdb/orbit-db)

92 -

93 -PSA: If you are a heavy user of `go-ipfs`, have developed a solid test infrastructure for your application and would love to help us would like to help us test `go-ipfs` release candidates, reach out to go-ipfs-wg@ipfs.io.

94 -

95 -### Release Stage 3 - Announce to the broader community

96 -

97 -- [ ] Documentation

98 - - [ ] Ensure that CHANGELOG.md is up to date

99 - - [ ] Ensure that README.md is up to date

100 - - [ ] Ensure that all the examples we have produced for go-ipfs run without problems

101 - - [ ] Update HTTP-API Documentation on the Website using https://github.com/ipfs/http-api-docs

102 -- [ ] Invite the community through (link to the release issue):

103 - - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)

104 - - [ ] Twitter

105 - - [ ] IRC

106 -

107 -### Release Stage 4 - Complete the Release

108 -

109 -- [ ] Final preparation

110 - - [ ] Verify that version string in `repo/version.go` has been updated

111 - - [ ] tag commit with vX.Y.Z

112 - - [ ] update release branch to point to release commit (`git merge vX.Y.Z`).

113 - - [ ] publish dist.ipfs.io

114 - - [ ] publish next version to https://github.com/ipfs/npm-go-ipfs

115 -- [ ] 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)

116 -- [ ] Broadcasting (link to blog post)

117 - - [ ] Twitter

118 - - [ ] IRC

119 - - [ ] Reddit

120 - - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)

121 - - [ ] Announce it on the [IPFS Users mlist](https://groups.google.com/forum/#!forum/ipfs-users)

122 -

123 -# ❤️ Huge thank you to everyone that made this release possible

124 -

125 -In alphabetical order, here are all the humans that contributed to the release:

126 -

127 -- <use script -- listed in Release Stage 4 -- to generate a list of everyone that contributed for this release>

128 -

129 -# 🙌🏽 Want to contribute?

130 -

131 -Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started:

132 -

133 -- Check the issues with the `help wanted` label in the [go-ipfs repo](https://github.com/ipfs/go-ipfs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)

134 -- Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt/#weekly-ipfs-all-hands

135 -- 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

136 -- Join the discussion at http://discuss.ipfs.io/ and help users finding their answers.

137 -- Join the [Go Core Dev Team Weekly Sync](https://github.com/ipfs/team-mgmt/issues/650) and be part of the Sprint action!

138 -

139 -# ⁉️ Do you have questions?

140 -

141 -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).

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 ```

136

137 ## Release Version Numbers (aka semver)