Skip to content

Commit e5c3f19

Browse files
authored
Add deps refresh guidance for maintainers (#3024)
Fixes issue #2850
1 parent f2c0765 commit e5c3f19

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

MAINTAINERS.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +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+
## Reviewing and merging dependency refreshes
15+
16+
At the start of each week the `.github/workflows/pip-compile-*` workflows run.
17+
These workflows bump dependencies and create pull requests such as [PR 2842](https://github.com/ansible/ansible-documentation/pull/2842).
18+
19+
PRs to bump dependencies should be merged in a timely fashion.
20+
The documentation repo categorizes dependencies into separate requirements files.
21+
The weekly schedule for workflow runs also ensures fewer dependencies are bumped at a time.
22+
This granularity and isolation helps us detect incompatibilities and issues that a new version of a dependency might introduce.
23+
24+
When reviewing PRs to refresh dependencies, look at the files changed and note the name of the requirements file.
25+
This corresponds to a check in CI; for example `tests/static.txt` contains the dependencies for the `nox / Run nox static session` check.
26+
27+
In general, CI check will emit errors or warnings if the dependency refresh introduces an issue of some kind.
28+
So basically, during review, expand the CI checks and look for problems in the output of the relevant steps.
29+
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.
30+
31+
In most cases, when a dependency refresh causes an issue, you probably need to adjust something in the appropriate session in `noxfile.py`.
32+
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.
33+
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).
34+
1435
## Updating scheduled builds for new major Ansible versions
1536

1637
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
3051
repository-branch: 'stable-2.19'
3152
```
3253
33-
3454
## Branching for new major stable versions
3555
3656
The branching strategy for this repository mirrors the [`ansible/ansible`](https://github.com/ansible/ansible) repository.

0 commit comments

Comments
 (0)