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

Add deps refresh guidance for maintainers (#3024)

Browse Source 
Fixes issue #2850
This commit is contained in:
Don Naro
2025-09-11 10:07:17 +01:00
committed by GitHub
parent f2c0765648
commit e5c3f19454
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
MAINTAINERS.md
View File

@@ -11,6 +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. 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. Send an email with the request to `opensource-legal@redhat.com` with `ansible-community-team@redhat.com` on copy.
## Reviewing and merging dependency refreshes
At the start of each week the `.github/workflows/pip-compile-*` workflows run.
These workflows bump dependencies and create pull requests such as [PR 2842](https://github.com/ansible/ansible-documentation/pull/2842).
PRs to bump dependencies should be merged in a timely fashion.
The documentation repo categorizes dependencies into separate requirements files.
The weekly schedule for workflow runs also ensures fewer dependencies are bumped at a time.
This granularity and isolation helps us detect incompatibilities and issues that a new version of a dependency might introduce.
When reviewing PRs to refresh dependencies, look at the files changed and note the name of the requirements file.
This corresponds to a check in CI; for example `tests/static.txt` contains the dependencies for the `nox / Run nox static session` check.
In general, CI check will emit errors or warnings if the dependency refresh introduces an issue of some kind.
So basically, during review, expand the CI checks and look for problems in the output of the relevant steps.
If there are no errors, warnings or other messages and the step has run successfully, the dependency bump should be fine to approve and merge.
In most cases, when a dependency refresh causes an issue, you probably need to adjust something in the appropriate session in `noxfile.py`.
For example, [PR 1172](https://github.com/ansible/ansible-documentation/pull/1172) bumped the version of `ruff` which resulted in a warning because the `static` session included a deprecated command.
To fix the issue, [PR 1191](https://github.com/ansible/ansible-documentation/pull/1191) updated the `ruff` command and was merged before [PR 1172](https://github.com/ansible/ansible-documentation/pull/1172).
## Updating scheduled builds for new major Ansible 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. When a new major Ansible version is released, you need to update the latest version in the scheduled docs build.
@@ -30,7 +51,6 @@ When a new major Ansible version is released, you need to update the latest vers
repository-branch: 'stable-2.19' repository-branch: 'stable-2.19'
``` ```
## Branching for new major stable versions ## Branching for new major stable versions
The branching strategy for this repository mirrors the [`ansible/ansible`](https://github.com/ansible/ansible) repository. The branching strategy for this repository mirrors the [`ansible/ansible`](https://github.com/ansible/ansible) repository.