1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
# Releasing
Bundler uses [Semantic Versioning](https://semver.org/).
_Note: In the documentation listed below, the *current* minor version number is
1.11 and the *next* minor version number is 1.12_
Regardless of the version, *all releases* must update the `CHANGELOG.md` and `lib/bundler/version.rb`
files. The changelog for the first stable minor release (`1.12.0`) is a sum of all
the preceding pre-release versions (`1.12.pre.1`, `1.12.pre.2`, etc) for that
minor version. The changelog for the first stable minor release is left blank
unless there are fixes included since the last pre/rc release.
## Workflow
In general, `master` will accept PRs for:
* feature merges for the next minor version (1.12)
* regression fix merges for a patch release on the current minor version (1.11)
* feature-flagged development for the next major version (2.0)
### Breaking releases
Bundler cares a lot about preserving compatibility. As a result, changes that
break backwards compatibility should (whenever this is possible) include a feature
release that is backwards compatible, and issue warnings for all options and
behaviors that will change.
We try very hard to only release breaking changes when incrementing the _major_
version of Bundler.
### Cherry picking
Patch releases are made by cherry-picking bug fixes from `master`.
When we cherry-pick, we cherry-pick the merge commits using the following command:
```bash
$ git cherry-pick -m 1 MERGE_COMMIT_SHAS
```
For example, for PR [#5029](https://github.com/bundler/bundler/pull/5029), we
cherry picked commit [dd6aef9](https://github.com/bundler/bundler/commit/dd6aef97a5f2e7173f406267256a8c319d6134ab),
not [4fe9291](https://github.com/bundler/bundler/commit/4fe92919f51e3463f0aad6fa833ab68044311f03)
using:
```bash
$ git cherry-pick -m 1 dd6aef9
```
The `rake release:prepare_patch` command will automatically handle
cherry-picking, and is further detailed below.
## Changelog
Bundler maintains a list of changes present in each version in the `CHANGELOG.md` file.
Entries should not be added in pull requests, but are rather written by the Bundler
maintainers before the release.
To fill in the changelog, maintainers can go through the relevant PRs using the
`rake release:open_unreleased_prs` and manually add a changelog entry for each
PR that it's about to be released.
If you're releasing a patch level version, you can use `rake
release:open_unreleased_prs` to instead label each relevant PR with the proper
milestone of the version to be release. Then the `rake release:patch` task will
go _only_ through those PRs, and prompt you to add a changelog entry for each of
them.
## Releases
### Minor releases
While pushing a gem version to RubyGems.org is as simple as `rake release`,
releasing a new version of Bundler includes a lot of communication: team consensus,
git branching, changelog writing, documentation site updates, and a blog post.
Dizzy yet? Us too.
Here's the checklist for releasing new minor versions:
* [ ] Check with the core team to ensure that there is consensus around shipping a
feature release. As a general rule, this should always be okay, since features
should _never break backwards compatibility_
* [ ] Create a new stable branch from master (see **Branching** below)
* [ ] Update `version.rb` to a prerelease number, e.g. `1.12.pre.1`
* [ ] Update `CHANGELOG.md` to include all of the features, bugfixes, etc for that
version.
* [ ] Run `rake release`, tweet, blog, let people know about the prerelease!
* [ ] Wait a **minimum of 7 days**
* [ ] If significant problems are found, increment the prerelease (i.e. 1.12.pre.2)
and repeat, but treating `.pre.2` as a _patch release_. In general, once a stable
branch has been cut from master, it should _not_ have master merged back into it.
Wait! You're not done yet! After your prelease looks good:
* [ ] Update `version.rb` to a final version (i.e. 1.12.0)
* [ ] In the [bundler/bundler-site](https://github.com/bundler/bundler-site) repo,
copy the previous version's docs to create a new version (e.g. `cp -r v1.11 v1.12`)
* [ ] Update the new docs as needed, paying special attention to the "What's new"
page for this version
* [ ] Write a blog post announcing the new version, highlighting new features and
notable bugfixes
* [ ] Run `rake release` in the bundler repo, tweet, link to the blog post, etc.
At this point, you're a release manager! Pour yourself several tasty drinks and
think about taking a vacation in the tropics.
Beware, the first couple of days after the first non-prerelease version in a minor version
series can often yield a lot of bug reports. This is normal, and doesn't mean you've done
_anything_ wrong as the release manager.
#### Branching
Minor releases of the next version start with a new release branch from the
current state of master: `1-12-stable`, and are immediately followed by a `.pre.1` release.
Once that `-stable` branch has been cut from `master`, changes for that minor
release series (1.12) will only be made _intentionally_, via patch releases.
That is to say, changes to `master` by default _won't_ make their way into any
`1.12` version, and development on `master` will be targeting the next minor
or major release.
### Patch releases (bug fixes!)
Releasing new bugfix versions is really straightforward. Increment the tiny version
number in `lib/bundler/version.rb`, and in `CHANGELOG.md` add one bullet point
per bug fixed. Then run `rake release` from the `-stable` branch,
and pour yourself a tasty drink!
PRs containing regression fixes for a patch release of the current minor version
are merged to master. These commits need to be cherry-picked from master onto
the minor branch (`1-12-stable`).
There is a `rake release:prepare_patch` rake task that helps with creating a patch
release. It takes a single argument, the _exact_ patch release being made (e.g.
`1.12.3`), but if not given it will bump the tiny version number by one. This
task checks out the appropriate stable branch (`1-12-stable`), grabs the
`1.12.3` milestone from GitHub, ensures all PRs are closed, and then
cherry-picks those changes (and only those changes) to a new branch based off
the stable branch. Then bumps the version in the version file and commits that
change on top of the cherry-picks.
Now you have a release branch ready to be merged into the stable branch. You'll
want to open a PR from this branch into the stable branch and provided CI is
green, you can go ahead, merge the PR and run `rake release` from the updated
stable branch.
## Beta testing
Early releases require heavy testing, especially across various system setups.
We :heart: testers, and are big fans of anyone who can run `gem install bundler --pre`
and try out upcoming releases in their development and staging environments.
There may not always be prereleases or beta versions of Bundler.
The Bundler team will tweet from the [@bundlerio account](https://twitter.com/bundlerio)
when a prerelease or beta version becomes available. You are also always welcome to try
checking out master and building a gem yourself if you want to try out the latest changes.
|
