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/contribute/branching-strategy.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,9 +46,9 @@ After it has been established that a repository should publish from a version br
46
46
* Otherwise, keeping it set to `main` is also an option since this is where the content is initially developed and merged. This is the default.
47
47
4. In the assembler PR, add the `ci` label. After CI runs, confirm that the intended version branches are publishing to the link service. When links are being published as intended, they can be found at the following URL, where `repo` is your repo name and `branch` is your newly configured branch:
Copy file name to clipboardExpand all lines: docs/contribute/release-new-version.md
+40-6Lines changed: 40 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,13 @@ When a new version of the Elastic Stack (or another versioned product) is releas
4
4
5
5
Follow these steps to release a new documentation version.
6
6
7
-
:::::{stepper}
7
+
:::{tip}
8
+
The docs-builder PR steps can be bundled into a single PR.
9
+
:::
10
+
11
+
:::::{stepper}
8
12
9
-
::::{step} Update `versions.yml`
13
+
::::{step} [docs-builder PR]Update `versions.yml`
10
14
11
15
_This action can be performed by any member of the docs team. It's also [automated](https://github.com/elastic/docs-builder/actions/workflows/updatecli.yml) for many products._
12
16
@@ -24,11 +28,40 @@ versioning_systems:
24
28
- Update the `current` version to reflect the newly released version.
25
29
- Only update the `base` version if you're dropping support for an older version.
26
30
27
-
Refer to [`versions.yml`](../configure/site/versions.md) for more information.
31
+
Refer to [`versions.yml`](/configure/site/versions.md) for more information.
32
+
33
+
::::
34
+
35
+
::::{step} [docs-builder PR] (Optional) Bump the version branch
36
+
_This action can be performed by any member of the docs team._
37
+
38
+
If you use the [tagged branching strategy](/contribute/branching-strategy.md), and your release corresponds with a new branch in the repository that holds your documentation, then you also need to bump the `current` and `next` branch in the docs configuration.
39
+
40
+
This step is not always required, depending on your branching strategy. For example, if you only have branches for major versions of your product (e.g. 1 and 2), and you're already publishing your docs from the `1` branch, then you don't need to bump the version branch to release version 1.2 or 1.2.3 of your documentation.
41
+
42
+
1. In `assembler.yml`, specifying the new `current` and `next` branches for your repository:
43
+
44
+
```yml
45
+
your-product:
46
+
current: 1.1
47
+
next: 1.2
48
+
```
49
+
50
+
Some people use `main` or `master` for their `next` branch. In this case, the `next` value doesn't need to be changed.
51
+
52
+
2. Tag the PR with the `ci` label. After CI runs, confirm that the intended version branches are publishing to the link service. When links are being published as intended, they can be found at the following URL, where repo is your repo name and branch is your newly configured branch:
_This action can be performed by any member of the docs team._
34
67
@@ -46,11 +79,11 @@ See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for mo
46
79
47
80
::::
48
81
49
-
::::{step} Approve and merge the config change
82
+
::::{step} [docs-builder PR] Approve and merge the config change
50
83
51
84
_This action must be performed by docs engineering._
52
85
53
-
Merge the `versions.yml` changes and any legacy URL mapping changes.
86
+
Merge the `versions.yml` changes and any assembler and legacy URL mapping changes.
54
87
55
88
Optionally, invoke the [Synchronize version & config updates](https://github.com/elastic/docs-internal-workflows/actions/workflows/update-assembler-version.yml) action manually on `docs-internal-workflows`, which opens two configuration update PRs: `staging`and `prod`.
56
89
@@ -91,3 +124,4 @@ Cumulative documentation relies on version metadata through `applies_to` blocks,
91
124
Check the built output to ensure `applies_to` changes are correctly rendering.
0 commit comments