Document details on releasing new versions off *-stable branches#8825
Document details on releasing new versions off *-stable branches#8825
*-stable branches#8825Conversation
The `*-stable` branches are maintained slightly differently than the `master` branch. This attempts to explain some of the differences.
@check-spelling-bot ReportUnrecognized words, please review:
Previously acknowledged words that are now absenteolTo accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands... in a clone of the git@github.com:jekyll/jekyll.git repository If you see a bunch of garbageIf it relates to a ... well-formed patternSee if there's a pattern that would match it. If not, try writing one and adding it to the Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines. Note that patterns can't match multiline strings. binary-ish stringPlease add a file path to the File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.
|
| It's recommended that you go over the `History.markdown` file manually one more time, in case there are any spelling errors or such. Feel free to fix those manually, and after you're done generating the website changelog, commit your changes. | ||
|
|
||
| ## Write a release post | ||
| ## Write a release post (`master` branch) |
There was a problem hiding this comment.
This changes the anchor for this heading. How about using {: #write-a-release-post}?
|
|
||
| ## Branches: `master` vs `*-stable` | ||
|
|
||
| We maintain several branches for major/minor releases that have since passed. For example, we maintain the `3.9-stable` branch for the `3.9.x` series since this is still used by GitHub Pages. This allows us to more easily make patches for bugs and security vulnerabilities. Maintaining a `*-stable` version is very similar to `master`, except that the jekyllrb.com blog post must (also) land on the `master` branch in order to be published. |
There was a problem hiding this comment.
The flow of this line an update:
| We maintain several branches for major/minor releases that have since passed. For example, we maintain the `3.9-stable` branch for the `3.9.x` series since this is still used by GitHub Pages. This allows us to more easily make patches for bugs and security vulnerabilities. Maintaining a `*-stable` version is very similar to `master`, except that the jekyllrb.com blog post must (also) land on the `master` branch in order to be published. | |
| We maintain several branches for major/minor releases that have since passed. For example, we maintain the `3.9-stable` branch for the `3.9.x` series since this is still used by GitHub Pages. This allows us to make patches for bugs and security vulnerabilities more easily. Maintaining a `*-stable` version is very similar to `master`, except that the blog post must land on the `master` branch in order to be published at jekyllrb.com. |
|
I'm ok with the proposed additions except that we have never created release post off stable branch and merged it twice.. |
*-stable branches
This is a 🔦 documentation change.
Summary
The
*-stablebranches are maintained slightly differently than themasterbranch. This attempts to explain some of the differences.Context
@ashmaroli asked me to update this page given that I'm going to be maintaining the
3.9-stablebranch.