centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-26 13:18:58 +07:00
Code Issues Packages Projects Releases Wiki Activity

Update docs in the readme and maintainers guide (#2766)

Browse Source 
* add docs build workflows to devel-only rm list

* add docs to update latest scheduled builds

* Update MAINTAINERS.md

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update MAINTAINERS.md

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Don Naro
2025-07-24 16:00:01 +01:00
committed by GitHub
parent caa2399fa4
commit e785685c7a
1 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
MAINTAINERS.md
View File

@@ -11,7 +11,27 @@ See [the Ansible calendar](https://forum.ansible.com/upcoming-events) for meetin
Any modifications to the `DCO` or `COPYING` file must be reviewed and approved by the Red Hat open-source legal team.
Send an email with the request to `opensource-legal@redhat.com` with `ansible-community-team@redhat.com` on copy.
## Branching for new stable versions
## Updating scheduled builds for new major Ansible versions
When a new major Ansible version is released, you need to update the latest version in the scheduled docs build.
1. Open `.github/workflows/build-latest-docs.yaml` for editing.
2. Modify the `repository-branch` and `ansible-package-version` fields in the `build-package-docs` and `deploy-package-docs` jobs, for example:
```yaml
# Values for the Ansible 11 release
with:
ansible-package-version: '11'
repository-branch: 'stable-2.18'
# Values for the Ansible 12 release
with:
ansible-package-version: '12'
repository-branch: 'stable-2.19'
```
## Branching for new major stable versions
The branching strategy for this repository mirrors the [`ansible/ansible`](https://github.com/ansible/ansible) repository.
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.
```bash
# Remove the following workflow files, the tagger script, and tagger requirements.
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.*
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.*
```
Next, remove references to the tagger dependencies as follows: