summaryrefslogtreecommitdiff
path: root/docs/dev/how_to
diff options
context:
space:
mode:
authorPete Higgins <pete@peterhiggins.org>2020-05-07 17:36:01 -0700
committerTim Smith <tsmith84@gmail.com>2020-05-18 20:29:40 -0700
commit773c285b051b66224d91636b9c8069ce232901cb (patch)
treeb2a521bad8c906e291c05ec1c6ab6b04642a4034 /docs/dev/how_to
parenta729c9be155e3d335fbd7bd165abd4ba9610943d (diff)
downloadchef-773c285b051b66224d91636b9c8069ce232901cb.tar.gz
More things clear of spellcheck violations.
Signed-off-by: Pete Higgins <pete@peterhiggins.org>
Diffstat (limited to 'docs/dev/how_to')
-rw-r--r--docs/dev/how_to/branching_and_backporting.md6
-rw-r--r--docs/dev/how_to/bumping_the_major_version.md2
2 files changed, 4 insertions, 4 deletions
diff --git a/docs/dev/how_to/branching_and_backporting.md b/docs/dev/how_to/branching_and_backporting.md
index b2b90edb50..8929c926e9 100644
--- a/docs/dev/how_to/branching_and_backporting.md
+++ b/docs/dev/how_to/branching_and_backporting.md
@@ -2,7 +2,7 @@
## Branch Structure
-We develop and ship the current release of Chef off the master branch of this repository. Our goal is that `master` should always be in a shipable state. Previous stable releases of Chef are developed on their own branches named by the major version (ex: chef-14 or chef-13). We do not perform direct development on these stable branches, except to resolve build failures. Instead, we backport fixes from our master branch to these stable branches. Stable branches receive critical bugfixes and security releases, and stable Chef releases are made as necessary for security purposes.
+We develop and ship the current release of Chef off the master branch of this repository. Our goal is that `master` should always be in a shippable state. Previous stable releases of Chef are developed on their own branches named by the major version (ex: chef-14 or chef-13). We do not perform direct development on these stable branches, except to resolve build failures. Instead, we backport fixes from our master branch to these stable branches. Stable branches receive critical bugfixes and security releases, and stable Chef releases are made as necessary for security purposes.
## Backporting Fixes to Stable Releases
@@ -12,10 +12,10 @@ If there is a critical fix that you believe should be backported from master to
3. Inspect the Git history and find the `SHA`(s) associated with the fix.
4. Backport the fix to a branch via cherry-pick:
1. Check out the stable release branch: `git checkout chef-14`
- 2. Create a branch for your backport: `git checkout -b my_great_bug_packport`
+ 2. Create a branch for your backport: `git checkout -b my_great_bug_backport`
3. Cherry Pick the SHA with the fix: `git cherry-pick SHA`
4. Address any conflicts (if necessary)
5. Push the new branch to your origin: `git push origin`
5. Open a PR for your backport
1. The PR title should be `Backport: ORIGINAL_PR_TEXT`
- 2. The description should link to the original PR and include a description of why it needs to be backported \ No newline at end of file
+ 2. The description should link to the original PR and include a description of why it needs to be backported
diff --git a/docs/dev/how_to/bumping_the_major_version.md b/docs/dev/how_to/bumping_the_major_version.md
index f9db9e525e..17332bf765 100644
--- a/docs/dev/how_to/bumping_the_major_version.md
+++ b/docs/dev/how_to/bumping_the_major_version.md
@@ -31,7 +31,7 @@ On your local machine fork the current master branch to a new stable branch. For
Once you’ve forked to a new stable branch such as `chef-15` you’ll want to create a new branch so you can build a PR, which will get this branch ready for release:
-- In ./expeditor/config.yml add the version_constraint for the new branch, update the version_constrant for master to match the new major version, and remove all the update_dep.sh subscriptions which don’t work against stable branches.
+- In ./expeditor/config.yml add the version_constraint for the new branch, update the version_constraint for master to match the new major version, and remove all the update_dep.sh subscriptions which don’t work against stable branches.
- In readme.md update the buildkite badge to point to the new stable branch image and link instead of pointing to master.
- In kitchen-tests/Gemfile update the Ohai branch to point to the new Ohai stable
- In kitchen-tests/kitchen.yml update chef_version to be your new stable version and not current. Ex: 15