Skip to content

Commit 51bddee

Browse files
committed
refresh release process
1 parent b66cc43 commit 51bddee

File tree

2 files changed

+38
-7
lines changed

2 files changed

+38
-7
lines changed

docs/configure/site/legacy-url-mappings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ en/elasticsearch/reference/:
1616
## Structure
1717
1818
`stack anchor`
19-
: Defines a reusable list of version strings for "stack" projects, e.g., [ '9.0+', '8.18', ... ].
19+
: Defines a reusable list of version strings for "stack" projects, e.g., [ '8.18', ... ].
2020

2121
`mappings`
2222
: A YAML mapping where each key is a legacy documentation URL path (like `en/apm/agent/java/`), and each value is a mapping with:

docs/contribute/release-new-version.md

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Follow these steps to release a new documentation version.
88

99
::::{step} Update `versions.yml`
1010

11+
_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+
1113
The `versions.yml` file defines the **base** (minimum) and **current** (latest) versions of each versioned product family.
1214

1315
Example:
@@ -28,28 +30,57 @@ Refer to [`versions.yml`](../configure/site/versions.md) for more information.
2830

2931
::::{step} (Optional) Update legacy URL mappings
3032

33+
_This action can be performed by any member of the docs team._
34+
3135
If you're releasing a version older than the current `base`, or restoring support for a previously removed version, you may need to update the `legacy-url-mappings.yml` file.
3236

3337
This file maps legacy URL paths (like `en/elasticsearch/reference/`) to the list of versions that exist at that path.
3438

3539
For example, to release the 8.19 version of the Elastic Stack, update the `stack` versions array to include the new version number:
3640

3741
```yml
38-
- stack: &stack [ '9.0+', '8.19', '8.18', '8.17', ... ]
42+
- stack: &stack [ '8.19', '8.18', '8.17', ... ]
3943
```
4044

45+
See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for more information.
46+
47+
::::
48+
49+
::::{step} Approve and merge the config change
50+
51+
_This action must be performed by docs engineering._
52+
53+
Merge the `versions.yml` changes and any legacy URL mapping changes.
54+
55+
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+
57+
This action also runs on a cron job, but you can trigger it manually if needed.
58+
4159
:::{important}
42-
The first version in the `mappings` list is treated as the "current" version in documentation version dropdown.
60+
Do not merge the production PR until release day!
4361
:::
4462

45-
See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for more information.
63+
::::
64+
65+
::::{step} After feature freeze: merge the config change to staging
66+
67+
_This action must be performed by docs engineering._
68+
69+
Merge [the `staging` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
70+
71+
:::{important}
72+
Do not merge the production PR until release day!
73+
:::
4674

4775
::::
4876

49-
::::{step} Release a new version of docs-builder
77+
::::{step} Release day: merge the config change to prod and release to production
78+
79+
_This action must be performed by docs engineering. For most products, this change must be merged on release day._
5080

51-
Version updates and content set additions require a release of docs-builder.
52-
Contact the Docs Eng team for assistance.
81+
1. Merge [the `prod` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
82+
2. Manually [invoke the release automation to production](https://github.com/elastic/docs-internal-workflows/actions/workflows/assembler-build.prod.yml).
83+
3. Let the requester or docs release coordinator know the docs have been updated.
5384

5485
::::
5586

0 commit comments

Comments
 (0)