Skip to content

Update docs in the readme and maintainers guide #2766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from
Open

Update docs in the readme and maintainers guide #2766

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b444f44
add docs build workflows to devel-only rm list
oraNod Jun 27, 2025
fee7be5
add docs to update latest scheduled builds
oraNod Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,26 @@ 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 `[email protected]` with `[email protected]` on copy.

## Updating scheduled builds for new Ansible versions

When a new Ansible version is released, you need to update the latest version in the scheduled docs build.
Comment on lines +14 to +16
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for new major versions, and not minor/bugfix versions, right?

Suggested change
## Updating scheduled builds for new Ansible versions
When a new Ansible version is released, you need to update the latest version in the scheduled docs build.
## 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 stable versions
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably here as well:

Suggested change
## Branching for new stable versions
## Branching for new major stable versions


The branching strategy for this repository mirrors the [`ansible/ansible`](https://github.com/ansible/ansible) repository.
Expand Down Expand Up @@ -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:
Expand Down