You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/release.md
+16-1
Original file line number
Diff line number
Diff line change
@@ -74,8 +74,23 @@ Please, take a look at the release notes <here link to GitHub release notes>.
74
74
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
75
75
[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.
76
76
77
+
### Write release description for non-developers
77
78
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
79
94
80
95
1. Clone the Rancher Turtles Docs repository locally:
0 commit comments