Skip to content

Commit d3dfa2f

Browse files
docs: add post-release step for release notes (#1055)
Signed-off-by: Carlos Salas <[email protected]>
1 parent 197c1bd commit d3dfa2f

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

Diff for: docs/release.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,23 @@ Please, take a look at the release notes <here link to GitHub release notes>.
7474
If a new minor/major branch was created, there are some post-release actions that need to be taken. If you cut a patch release before, please disregard
7575
[publish a new Turtles Community Documentation version](#publish-a-new-rancher-turtles-community-docs-version) and [create a JIRA ticket for Documentation syncing](#create-a-jira-ticket-for-syncing-turtles-community-docs-with-product-docs) steps below.
7676

77+
### Write release description for non-developers
7778

78-
### Publish a new Rancher Turtles Community Docs version
79+
Turtles release notes are automatically generated based on the commits that are published with the new version.
80+
81+
These commit messages are usually hard to understand for those that are not very familiar with the project and we must add a "human-readable" description of what the release brings at the beginning of release notes. [This](https://github.com/rancher/turtles/releases/tag/v0.13.0) can be used for reference.
82+
83+
### Rancher Turtles Community Documentation
84+
85+
#### Generate changelog from Turtles release notes
86+
87+
Before publishing a new version of the documentation, a new [Changelog](https://turtles.docs.rancher.com/turtles/next/en/changelogs/index.html) must be generated to include the new release.
88+
89+
1. Navigate to the Rancher Turtles Docs repository: [rancher/turtles-docs](https://github.com/rancher/turtles-docs)
90+
2. Go to `Actions` and start a new run of `Updatecli`.
91+
3. This will generate a new PR in the same repository that adds the release notes from any new Turtles release.
92+
93+
#### Publish Rancher Turtles Docs
7994

8095
1. Clone the Rancher Turtles Docs repository locally:
8196

0 commit comments

Comments
 (0)