diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 7e13cf5b9d..110df7dfa2 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -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. 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 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' ``` - ## Branching for new major stable versions The branching strategy for this repository mirrors the [`ansible/ansible`](https://github.com/ansible/ansible) repository.