Describe the documentation steps of the release process #3476
Conversation
These steps have not been automated (and might not be automatable). But more importantly, they were not clearly defined. This PR is an attempt at sharing knowledge following the lessons learned during 1.3.0 release.
| Now that the release artifacts have been published, the next step is to publish the associated documentation on the website. Checkout the `versioned-docs` branch locally and copy the documentation associated to the release tag at the root of the repository. | ||
|
|
||
| ``` | ||
| git checkout -b versioned-docs-[major].[minor].[patch] versioned-docs |
There was a problem hiding this comment.
Noting there's the script site/bin/checkout-releases.sh do this (into content/releases), just via Git worktrees. site/bin/remove-releases.sh removes the Git worktree.
There was a problem hiding this comment.
TIL that a worktree can be added as a subdirectory of the current branch. I wonder if it could be confusing that any git commit made inside that worktree will be for the versioned-docs branch even though the current repo is no another branch. Also the worktree would need to be removed after the release to avoid confusion/mistakes. But on the other hand, it would replace the git archive long command by a simpler recursive cp...
There was a problem hiding this comment.
Nah, there's technically no issue w/ Git (it's smart ;) ).
From experience, I'd recommend to remove the "inner worktree" as soon as possible, because IDEs like IntelliJ recognize the "inner worktree" and for example fold that history in the Git view, which is then a bit confusing.
2 participants
These steps have not been automated (and might not be automatable). But more importantly, they were not clearly defined. This PR is an attempt at sharing knowledge following the lessons learned during 1.3.0 release.
I have updated both the semi-automated release guide and manual release guide for completeness.
@jbonofre @flyrain @singhpk234 does this match your recollection from previous releases?