Document releasing off *-stable branches
#8984
Conversation
|
@parkr Since you'll be overseeing the release(s) from our |
| primarily in reverse chronological order and secondarily scoped to the semver-major-version. For example, a release section for `v3.9.2` | ||
| will be listed above the section for `v3.9.1` but under release sections for v4.x. | ||
| The snippet stashed earlier has to be injected into the correct location manually. | ||
| 3. Optionally, update `VERSION` string in `lib/jekyll/version.rb`. (*If existing version is lesser than latest version*). |
There was a problem hiding this comment.
When would this be the case? When we branch off for a major release and we have release candidates on master and a stable branch for the latest minor release from the previous major release? E.g. 4.0.0.rc1 is on master so we're releasing from 3.9-stable but we want the Jekyll website to reflect a stable (non-RC) version?
There was a problem hiding this comment.
When would this be the case?
It happens when we're patching mainstream series. In fact, it happens right now, actually.
The current master contains commits deemed to bump the minor version. Understandably, we cut patches for the 4.2.x series from the 4.2-stable branch (even though 4.2.x is the current mainstream series).
However, once 4.2-stable advances to v4.2.2 or v4.2.3, master cannot remain at (older / lesser than) v4.2.1 since jekyllrb.com is deployed off the master.
So, we have to update the version.rb on master as well in a consecutive step.
But, if we were cutting a release for an older series, say, 3.9.x or even 4.1.x, then version.rb on master doesn't reed to be updated.
| ## Publish GitHub Release | ||
|
|
||
| Unlike releases cut off the `master` branch, our JekyllBot does not automatically create and publish a GitHub Release for tags created from | ||
| *non-default* branches. Therefore, the maintainer has to **manually create and publish** the concerned GitHub Release. |
There was a problem hiding this comment.
I'd be happy to see us use jekyllbot for releases off these stable branches, including autogenerating GitHub Releases and shipping to RubyGems.
There was a problem hiding this comment.
You're more familiar with JekyllBot's codebase than I am. So, you're better positioned to deploy a patch quicker than from a collaborator.
|
@jekyllbot: merge +doc |
Ashwin Maroli: Document releasing off `*-stable` branches (#8984) Merge pull request 8984
Summary
Document the various steps maintainers need to follow to ship releases of
*-stablebranches.Context
Based on latest experience from shipping
v4.2.2Closes #8825 (prior art by @parkr)