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.
The lockfiles for the pip-compile session itself were never updated
because I forgot to add them to the update workflow.
The pr_labeler lockfile is still excluded, but that's intentional for
now. I'd like this to happen manually or as part of a separate automated
workflow for now, as there's no automated tests for that script as of
yet, so I don't want it to randomly break when we merge these general
pip-compile-dev PRs.
Previously, this only would create a PR when the branch was newly
created earlier in the workflow (assuming that branches would be deleted
once the previous dependency update PR was merged), but it was possible
for the branch to already exist but not have a PR open against it.
This uses the Github API to properly check whether a PR already exists.
* Add yamllint check for RST code listings.
* Address review comments.
* Sort languages and remove no longer needed duplicates.
* Enable warnings, but disable all failing rules.
* Improve formulation.
Co-authored-by: Don Naro <dnaro@redhat.com>
* Show allowed languages when no or invalid language is supplied. Improve line lengths.
* Make sure that 'yamllint .' passes.
* Fix indentation issues introduced in #2095.
---------
Co-authored-by: Don Naro <dnaro@redhat.com>
* fixes#2047 restructure package docs workflow
This change splits the package docs workflow into reusable parts for
flexibility so that we can run different builds on various schedules.
---------
Co-authored-by: Felix Fontein <5781356+felixfontein@users.noreply.github.com>
CI jobs for stable-2.18 and stable-2.17 were failing before this; they
use a different Python version for lockfile generation that was not
incidentally installed like Python 3.11.
* nox pip-compile: support check mode
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.
* ci: remove push trigger for pip-compile workflows
Now that we have the pip-compile-check job, this is redundant. PR checks
will fail if lockfiles are out-of-sync, so there's no need to run the
complete pip-compile workflow that performs a full update of the
dependencies. Complete updates are still performed on a weekly basis.
This PR integrates [actionlint](https://github.com/rhysd/actionlint)
into our CI pipeline to check our Github Actions for best practices and
common errors.
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.
* WIP
* setting in-line defaults for running on a schedule
* ci: refresh dev dependencies (#1634)
Remove latest symlink from publishing workflow (#1615)
* remove latest symlink
Read The Docs allows you to configure which version corresponds to
"latest" which means the symlink is no longer necessary.
* add 11 to version list
Co-authored-by: Sandra McCann <30267855+samccann@users.noreply.github.com>
ci: refresh docs build dependencies (#1635)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
fix Validate data against set criteria with Ansible doc (#1636)
fixed following example playbook
fix Ansible architecture docs (#1637)
I fixed example Inventory ini format file contains '---' used in Yaml
Integrate the `alls-green` action into the main GHA CI workflow (#1639)
* Integrating all-greens into ci.yml
* removing non-existing references
When rebuilding this work after repo cleanup, I missed removing these. Thanks for catching that.
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
* Update .github/workflows/ci.yaml
---------
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Don Naro <dnaro@redhat.com>
Remove reference of scp_if_ssh option (#1346)
* Remove reference of scp_if_ssh option
* scp_if_ssh is removed in Ansible 2.17, remove the references
Fixes: #1341
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
* review changes
Co-authored-by: Maxwell G <maxwell@gtmx.me>
* details about the smart setting
---------
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Don Naro <dnaro@redhat.com>
Remove references to archived ansible/ansible-examples repository (#1653)
docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: avoid using aliases (#1539)
* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases
* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst
Co-authored-by: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst
Co-authored-by: flowerysong <junk+github@flowerysong.com>
---------
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
[WIP, needs vote before merging] collection_requirements.rst: update (#1422)
* collection_requirements.rst: update
* general updates
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
* releasing policy MUST -> SHOULD
* Remove setting upper bound warning
* fix formatting
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Remove the Requirements for collections to be included in the Ansible Package section
* Update galaxy section
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Remove extra line
* Update Documentation requirements section
* CoC feedback incorporate
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Fix unnoticed conflict
* Reformulate changelog section
* Restructure Contributor Workflow section
* Fix typo
* Add sentence back
* Restructure section
* Handle Naming section
* Handle Licensing section
* Restructure Licensing section
* Fix typo
* Update repo management section
* Update branch name and protection section
* Undate CI testing section
* Update When moving modules between collections section
* Update Development conventions section
* Update Collection dependencies section
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Restructure backwards compatibility section
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
* Fix formatting|
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
communication guide: overhaul (#1667)
communication guide: overhaul
* Forum as default
* Reorder so important information is at the top
* remove old information
---------
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: John Barker <john@johnrbarker.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
ci: refresh dev dependencies (#1657)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
ci: refresh docs build dependencies (#1658)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
Output workflow parameters for approval details (#1650)
* Output workflow parameters for approval details
---------
Co-authored-by: Don Naro <dnaro@redhat.com>
ci: refresh dev dependencies (#1675)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
ci: refresh docs build dependencies (#1676)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
Nightly builds for package docs publishing workflow (#1663)
Adding daily schedule to CI build (#1659)
* Adding daily schedule to CI build
* Change from 0 minute to 23, per discussion and referenced suggestion.
remove the schedule from the workflow dispatch job (#1683)
Relates to issue #1682. This change removes the schedule to stop the
workflow from failing due to null input values. We can either add this
back with some expressions to set defaults for scheduled runs or create
a simplified build workflow that runs on a schedule.
notify docs matrix channel on docs build failures (#1651)
* notify docs matrix channel on docs build failures
* add url with run id
Remove language option from workflow (#1681)
* Remove deprecated language input from the publishing workflow
collection_requirements: fix typo (#1684)
* collection_requirements: fix typo
* Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
---------
Co-authored-by: Don Naro <dnaro@redhat.com>
WIP
restore anchor in communication guide (#1692)
Add porting guide for Ansible 10.2.0. (#1697)
Add porting guide for Ansible 9.8.0. (#1698)
Move community_topics_workflow to docs.ansible.com (#1028)
* Move community_topics_workflow to docs.ansible.com
* Simplify
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Mario Lenz <m@riolenz.de>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Mario Lenz <m@riolenz.de>
* Improve
* Replacing Creating a topic section content
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
* Clarify
* Update docs/docsite/rst/community/steering/community_topics_workflow.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
---------
Co-authored-by: Mario Lenz <m@riolenz.de>
Co-authored-by: Don Naro <dnaro@redhat.com>
ci: refresh docs build dependencies (#1691)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
Issue #1633 nox session for tagging (#1649)
* WIP tagger session for nox
* First pass tagging nox session
* Formatting fixup
* Adding removal of tmpdir as per discussion
* tag session checks for, and uses, existing ansible checkout if it exists, removes tmpdir if it created one.
* isort fixup
* Working out suggested changes.
* Linting cleanup on changes
* Different approach to noted chagnes
* Reducing tagging session to a bare bones wrapper around the script, leaving all repo management alone
* Staging deletion per discussion
* Adding tag session to dependency update job
* after removing hacking/tagger/requirements.txt moved "gitpython" here for the typing test session requiremnts.
* Adding that here didd not accomplish what I'd expected. Removing it and revisiting how to do that.
* I think this is where the call needed added to get the tags dependencies automatically updated
* remove gitpython, add tag.txt, add blank line
* Comment cleanup per OraNod
* doc README: document nox tag session instead of manual mode
* Update tests/typing.in
Per suggestion from @webnjaz
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
---------
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
ci: refresh dev dependencies (#1707)
* ci: refresh dev dependencies
* ci: refresh dev dependencies
---------
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
Be more explicit about registering with a loop (#1709)
add vault password file example (#1696)
* add vault password file example
* remove duplicate word in vault password file example
Co-authored-by: Sandra McCann <samccann@redhat.com>
---------
Co-authored-by: Sandra McCann <samccann@redhat.com>
ci: refresh dev dependencies (#1722)
Co-authored-by: Ansible Documentation Bot <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
setting in-line defaults for running on a schedule
* Implementing comments
---------
Co-authored-by: ansible-documentation-bot[bot] <147556122+ansible-documentation-bot[bot]@users.noreply.github.com>
* WIP tagger session for nox
* First pass tagging nox session
* Formatting fixup
* Adding removal of tmpdir as per discussion
* tag session checks for, and uses, existing ansible checkout if it exists, removes tmpdir if it created one.
* isort fixup
* Working out suggested changes.
* Linting cleanup on changes
* Different approach to noted chagnes
* Reducing tagging session to a bare bones wrapper around the script, leaving all repo management alone
* Staging deletion per discussion
* Adding tag session to dependency update job
* after removing hacking/tagger/requirements.txt moved "gitpython" here for the typing test session requiremnts.
* Adding that here didd not accomplish what I'd expected. Removing it and revisiting how to do that.
* I think this is where the call needed added to get the tags dependencies automatically updated
* remove gitpython, add tag.txt, add blank line
* Comment cleanup per OraNod
* doc README: document nox tag session instead of manual mode
* Update tests/typing.in
Per suggestion from @webnjaz
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
---------
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Relates to issue #1682. This change removes the schedule to stop the
workflow from failing due to null input values. We can either add this
back with some expressions to set defaults for scheduled runs or create
a simplified build workflow that runs on a schedule.
* remove latest symlink
Read The Docs allows you to configure which version corresponds to
"latest" which means the symlink is no longer necessary.
* add 11 to version list
Co-authored-by: Sandra McCann <30267855+samccann@users.noreply.github.com>
The Read The Docs project for the package docs builds use the "Multiple versions without translations" versioning scheme. The resulting url has the `<version>/<filename>` format.
This change configures the publishing workflow to use the package
version as the branch name in the destination repository. For example
the branch name should be "10" for the Ansible 10 package. This ensures
that the resulting url for the published docs uses the version and not
the branch name.
* add steps to deploy doc build assets to prod
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
* Update .github/workflows/build-package-docs.yaml
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
* use GH actions bot
* environment name and url
* add input for deploy job and target
* add git diff-index quiet head
* use deploy key and git push
* add steps to deploy to gh-pages as a test site
* update branch name input for prod
* make envs more consistent
* use same branch name for destination
* rm extra empty line
* Update .github/workflows/build-package-docs.yaml
Co-authored-by: Felix Fontein <felix@fontein.de>
* github env consistency
* simplify tar extract step to use one-top-level
* Update .github/workflows/build-package-docs.yaml
Co-authored-by: Felix Fontein <felix@fontein.de>
* set environment url
---------
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Felix Fontein <felix@fontein.de>
this change fixes an issue with the docs build workflow so that the
input to create a symlink is applied correctly, otherwise the symlink is
always created
