We should use the official action for retrieving the token to use for
the issue/PR triage and dependency update workflows instead of the one
we were using before.
- Added entry for "ID" (Identification/Identifier) to the spelling and word choice guide.
- Clarified correct usage as "ID" (all uppercase) and specified avoiding variations like "Id" or "id".
- Provided examples and reasoning for consistent capitalization.
Resolves: ansible/ansible-documentation#2326
Signed-off-by: Ganesh Hubale <ganeshhubale03@gmail.com>
(cherry picked from commit 8e331e4b16)
Co-authored-by: Ganesh Hubale <ganeshhubale03@gmail.com>
This change adds the LICENSE and DCO files to CODEOWNERS and
specifies the community docs maintainers team as owners.
The purpose of this change is to prevent any unintentional or
unauthorized modifications to these files. Resolves#2178
* update some links
* remove galax details and leave it to galaxy docs
(cherry picked from commit 7f11306526)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Reference to group_by_module was substituted in where it did not make
sense: https://github.com/ansible/ansible/pull/43856
This reference is not essential. It is already referenced
indirectly, via :ref:`os_variance`.
Revert back to referencing the variables page.
Credit for fix and diagnosis: @samccann. See issue #2077.
(cherry picked from commit 4f0f5d1cf2)
Co-authored-by: Alan Jenkins <alan.christopher.jenkins@gmail.com>
* Remove ansible-test sanity from local module development
* Update docs/docsite/rst/dev_guide/developing_modules_general.rst
(cherry picked from commit ef72400cc2)
Co-authored-by: Sandra McCann <samccann@redhat.com>
* add example of extending ansible_facts
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit d693f43ba7)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Support a custom --check flag to fail if pip-compile made any changes so
we can check that that lockfiles are in sync with the input (.in) files.
(cherry picked from commit cb295b1f78)
Closes#1895.
Correct example so it behaves as described in the docs. The message "No such file or directory" is sent to stderr, not to stdout.
(cherry picked from commit 7063491dc8)
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* pr_labeler: improve create_boilerplate_comment logging
(cherry picked from commit 5730ba9a01)
* pr_labeler: add --force-process-closed flag
(cherry picked from commit 44ffe0f210)
* pr_labeler: add warning for porting_guides changes
This adds a warning message when PRs are created that edit
porting_guides by someone outside of the Release Management WG. These
files are automatically generated during the ansible release process and
should not be modified.
Fixes: https://github.com/ansible/ansible-documentation/issues/503
(cherry picked from commit d2e6625e8b)
* pr_labeler: use @release-management-wg team for porting_guide check
Instead of hardcoding the list of release managers, we can use the
Github API to retrieve the members of the
`@ansible/release-management-wg` team.
(cherry picked from commit dddfd7eb55)
* pr_labeler: exempt bots from porting_guide check
For example, patchback is not a release manager, but we still want it to
backport Porting Guide PRs.
(cherry picked from commit 746662c255)
* pr_labeler: improve porting_guide_changes template wording
Co-authored-by: Sandra McCann <samccann@redhat.com>
(cherry picked from commit 95ece7e9d6)
* pr_labeler: refactor new_contributor_welcome code (#990)
* pr_labeler: add GlobalArgs.full_repo property
* pr_labeler: refactor new_contributor_welcome code
As of https://github.com/ansible/ansible-documentation/issues/69, the
pr_labeler responds with a welcome message when an issue or PR is opened
by a new contributor. It turns out this never actually worked properly.
The previous method that relied on Github's `author_association` flag
did not work with the app token that the pr_labeler uses. This refactors
the code to figure out whether a user is a new contributor by
searching the list of issues and PRs.
Fixes: https://github.com/ansible/ansible-documentation/issues/204
* pr_labeler: address potential race condition
(cherry picked from commit 763815d1ad)
* Bump actions/setup-python from 4 to 5 (#966)
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v4...v5)
---
updated-dependencies:
- dependency-name: actions/setup-python
dependency-type: direct:production
update-type: version-update:semver-major
...
(cherry picked from commit 466b1fdc43)
* pr_labeler: re-architect triager script (#1882)
This commit reorganizes the issue/PR triager script and updates the
workflow to run more efficiently.
- Make the script a proper Python package instead of an unwieldy single
file
- Use locked dependencies and UV to decrease workflow runtime to under
10 seconds.
(cherry picked from commit 7138e42716)
(cherry picked from commit 1cf9f7917b)
---------
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Github Actions makes it easy to inject arbitrary shell code into Github
Actions scripts thanks to the way its templating language works.
This change mediates that issue by passing action inputs to the `run:`
scripts as env vars instead of using `${{ }}` expansions directly in the
script bodies.
The pr_labeler job is the only one that both runs on pull requests and
has access to secrets, but we don't interpolate anything other than
`github.event.number`, so that wouldn't allow any malicious person to
steal credentials.
reusable-pip-compile has access to secrets and accepts user input, but
only from trusted sources (i.e., developers who already have write
access to this repository) and can manually trigger workflows.
Still, it's a good to tighten this up.
(cherry picked from commit 5ebf9f1686)
* Replace old communication refs with Communication guide ref or forum
* Update docs/docsite/rst/community/documentation_contributions.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit bf86a30bef)
* Replace communication links with a link to communication guide
* Update docs/docsite/rst/command_guide/intro_adhoc.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/plugins/become.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/plugins/cache.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/plugins/callback.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/plugins/cliconf.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* fix
---------
Co-authored-by: Don Naro <dnaro@redhat.com>
(cherry picked from commit ae59246f0b)
Co-authored-by: Andrew Klychkov <aklychko@redhat.com>
Based on general discussions we've been having over the past year about
inactive steering committee members, I figured we should clarify the
team representative section that we recently added (for Core and
potentially other teams in the future).
(cherry picked from commit 5adb400dc2)
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Nox now has a separate venv backend that uses the Rust-based pip
replacement, uv. Let's add support for this to our install function so
that the constraints are respected when using the uv backend.
(cherry picked from commit a74da7db41)
Co-authored-by: Maxwell G <maxwell@gtmx.me>
