Skip to content

Commit 33ce90f

Browse files
authored
Update maintainer notes (google#2637)
1 parent de60b6d commit 33ce90f

1 file changed

Lines changed: 34 additions & 20 deletions

File tree

docsy.dev/content/en/project/about/maintainer-notes.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ If not adjust accordingly.
153153
release, and `release` for patch releases.
154154

155155
```sh
156-
BASE=main
156+
BASE=main # or release for patch releases
157157
```
158158

159159
- Commit any changes accumulated from the previous steps using this title:
@@ -319,7 +319,7 @@ If not adjust accordingly.
319319
git push-all-remotes deploy/prod
320320
```
321321
322-
For patch releases from `release`, selectively merge from `$BASE`.
322+
For patch releases from `release`, selectively merge from `release`.
323323
324324
The branch update will trigger a production deploy of the website.
325325
@@ -358,6 +358,38 @@ If not adjust accordingly.
358358
so, get fixes submitted, reviewed and approved. Go back to step 1 to publish
359359
a dot release.
360360
361+
21. **Update the `release` branch** once the release is final.
362+
363+
For a stable release, fast-forward `release` to the final release commit
364+
from `main`:
365+
366+
```sh
367+
git checkout release
368+
git merge --ff-only main
369+
git push-all-remotes release
370+
```
371+
372+
For patch releases, the release-prep PR should already target `release`, so
373+
there is no separate `main` to `release` fast-forward.
374+
375+
22. Update the [doc-rooted][] branch from [deploy/prod][]:
376+
377+
```sh
378+
git checkout doc-rooted
379+
git merge --ff-only deploy/prod
380+
npm run doc-rooted -- build
381+
# Optionally take a look at the preview
382+
npm run doc-rooted -- serve
383+
curl http://localhost:1313/index.md
384+
# Push the changes
385+
git push-all-remotes doc-rooted
386+
```
387+
388+
If the fast-forward merge fails, stop and reconcile the branch history. Once
389+
pushed, wait for the Netlify deploy and check the doc-rooted preview.
390+
391+
23. Update, create, or close GitHub milestones as appropriate.
392+
361393
If all is well, release the Docsy example as detailed next.
362394
363395
## Docsy example release
@@ -386,24 +418,6 @@ with the following modifications:
386418
https://github.com/google/docsy-example/releases/new
387419
[example.docsy.dev]: https://example.docsy.dev
388420
389-
## Doc-rooted release
390-
391-
Update the [doc-rooted][] branch from [deploy/prod][]:
392-
393-
```sh
394-
git checkout doc-rooted
395-
git merge --ff-only deploy/prod
396-
npm run doc-rooted -- build
397-
# Optionally take a look at the preview
398-
npm run doc-rooted -- serve
399-
curl http://localhost:1313/index.md
400-
# Push the changes
401-
git push-all-remotes doc-rooted
402-
```
403-
404-
If the fast-forward merge fails, stop and reconcile the branch history. Once
405-
pushed, wait for the Netlify deploy and check the doc-rooted preview.
406-
407421
## Post Docsy-release followup
408422
409423
Assuming that both the Docsy and Docsy-example releases {{% param version %}}

0 commit comments

Comments
 (0)