Skip to content

Commit f34c286

Browse files
authored
Clarify Netlify docs for Major/minor releases (#5251)
Closes #5234 Signed-off-by: austin <[email protected]>
1 parent 9204ee4 commit f34c286

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

website/content/en/docs/contribution-guidelines/releasing.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,14 @@ We will use the `v1.3.0` release version in this example.
5050

5151
### Before starting
5252

53-
1. A release branch must be created and [mapped][netlify-deploy] _before the release begins_
54-
to appease the Netlify website configuration demons. You can ping SDK [approvers][doc-owners] to ensure a
55-
[release branch](#release-branches) is created prior to the release and that this mapping is created.
56-
If you have the proper permissions, you can do this by running the following,
57-
assuming the upstream SDK is the `upstream` remote repo:
53+
1. **Before creating a new branch**, a [Netlify admin][doc-owners] must add `v1.13.x`
54+
to [Branch
55+
Deploys](https://app.netlify.com/sites/operator-sdk/settings/deploys#branches).
56+
This will watch for this branch when there are changes on Github
57+
(creating the branch, or adding a commit).
58+
1. A release branch must be created. If you have the proper permissions,
59+
you can do this by running the following, assuming the upstream SDK
60+
is the `upstream` remote repo:
5861
```sh
5962
git checkout master
6063
git pull
@@ -147,6 +150,11 @@ git push -f upstream v1.3.x
147150

148151
### 6. Post release steps
149152

153+
- Publish the new Netlify subdomain. Assuming that the Netlify prestep
154+
was done before the new branch was created, a new [branch
155+
option](https://app.netlify.com/sites/operator-sdk/settings/domain#branch-subdomains)
156+
should be visible to Netlify Admins and can be mapped to a subdomain. Please test that this subdomain
157+
works before announcing.
150158
- Make an [operator-framework Google Group][of-ggroup] post.
151159
- Post to Kubernetes slack in #kubernetes-operators and #operator-sdk-dev.
152160
- In the [GitHub milestone][gh-milestones], bump any open issues to the following release.
@@ -311,12 +319,11 @@ Prior to an Operator SDK release, add bindata (if required) for a new OLM versio
311319

312320
### Patch releases in parallel:
313321

314-
- Releasing in order is nice but not worth the inconvenience. Release order affects the order on GitHub releases, and which
322+
- Releasing in order is nice but not worth the inconvenience. Release order affects the order on GitHub releases, and which
315323
is labeled "latest release".
316324
- Do not unlock v.* branches while other releases are in progress. Instead, have an admin do the merges.
317325
- Release announcements should be consolidated.
318326

319-
[netlify-deploy]:https://docs.netlify.com/site-deploys/overview/#deploy-summary
320327
[doc-owners]: https://github.com/operator-framework/operator-sdk/blob/master/OWNERS
321328
[release-page]:https://github.com/operator-framework/operator-sdk/releases
322329
[backports]:/docs/upgrading-sdk-version/backport-policy

0 commit comments

Comments
 (0)