Skip to content

Commit e785685

Browse files
oraNodfelixfontein
andauthored
Update docs in the readme and maintainers guide (#2766)
* add docs build workflows to devel-only rm list * add docs to update latest scheduled builds * Update MAINTAINERS.md Co-authored-by: Felix Fontein <[email protected]> * Update MAINTAINERS.md Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]>
1 parent caa2399 commit e785685

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

MAINTAINERS.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,27 @@ See [the Ansible calendar](https://forum.ansible.com/upcoming-events) for meetin
1111
Any modifications to the `DCO` or `COPYING` file must be reviewed and approved by the Red Hat open-source legal team.
1212
Send an email with the request to `[email protected]` with `[email protected]` on copy.
1313

14-
## Branching for new stable versions
14+
## Updating scheduled builds for new major Ansible versions
15+
16+
When a new major Ansible version is released, you need to update the latest version in the scheduled docs build.
17+
18+
1. Open `.github/workflows/build-latest-docs.yaml` for editing.
19+
2. Modify the `repository-branch` and `ansible-package-version` fields in the `build-package-docs` and `deploy-package-docs` jobs, for example:
20+
21+
```yaml
22+
# Values for the Ansible 11 release
23+
with:
24+
ansible-package-version: '11'
25+
repository-branch: 'stable-2.18'
26+
27+
# Values for the Ansible 12 release
28+
with:
29+
ansible-package-version: '12'
30+
repository-branch: 'stable-2.19'
31+
```
32+
33+
34+
## Branching for new major stable versions
1535
1636
The branching strategy for this repository mirrors the [`ansible/ansible`](https://github.com/ansible/ansible) repository.
1737
When a new `stable-*` branch is created in the core repository, a corresponding branch in the `ansible-documentation` repository needs to be created.
@@ -54,7 +74,7 @@ After creating a new stable branch, remove the appropriate files and references.
5474

5575
```bash
5676
# Remove the following workflow files, the tagger script, and tagger requirements.
57-
git rm -r .github/workflows/pip-compile-dev.yml .github/workflows/pip-compile-docs.yml .github/workflows/reusable-pip-compile.yml .github/workflows/tag.yml .github/workflows/build-package-docs.yaml hacking/tagger tests/tag.*
77+
git rm -r .github/workflows/pip-compile-*.yml .github/workflows/reusable-pip-compile.yml .github/workflows/tag.yml .github/workflows/build-*-docs.yaml .github/workflows/reusable-*-docs.yaml hacking/tagger tests/tag.*
5878
```
5979

6080
Next, remove references to the tagger dependencies as follows:

0 commit comments

Comments
 (0)