* improve doc dependency install steps (#80120)
(cherry picked from commit 352010f9c3)
* docs: automatic `always` tag in gather_facts (#80052)
(cherry picked from commit 3216e071c7)
* docsite requirements path (#80134)
(cherry picked from commit 1055803c3a)
* Adjust release schedule docs to four weeks (#80166)
(cherry picked from commit 7ce951ff48)
* Fix spelling and grammar in subelements filter doc (#80137)
(cherry picked from commit 12c1891ce6)
* Fixed typo (#80184)
`uvault` should be `unvault`
(cherry picked from commit cb2180e286)
* Document debugging conditionals (#80239)
##### SUMMARY
Add a section to the docs describing how to debug conditional statements - how to get Ansible to show you whether your `when:` clause evaluates to `true` or `false`.
I ran into trouble with this and couldn't find anything in the docs. Thought I'd add it.
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
(cherry picked from commit 507fd1bd60)
* Update connection.rst (#80194)
(cherry picked from commit 0937cc4862)
---------
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Jairo Llopis <973709+yajo@users.noreply.github.com>
Co-authored-by: Kristian Heljas <11139388+kristianheljas@users.noreply.github.com>
Co-authored-by: Zachary Peschke <8718570+zpeschke@users.noreply.github.com>
Co-authored-by: Harmdhast <pandemonium.harmdhast@gmail.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-authored-by: Esther Christopher <estheradamuchris@gmail.com>
* Add _convert_rst_in_template_to_manpage arg types
* 📦 Make manpage build dependencies conditional
Previously, said dependencies were declared as unconditionally
required even when manpages not needed to be built. This patch
Makes it so they are only required when needed.
* Correct _generate_rst_in_templates returned type
It was marked as Path before this patch but in fact, it's iterable of
paths.
* 🎨 Convert RST to manpage in-memory @ PEP 517
Previously, the automation was writing a temporary templated RST on
disk and calling a helper CLI script on that. But with this change, it
happens with less unnecessary I/O.
Co-Authored-By: Matt Davis <6775756+nitzmahone@users.noreply.github.com>
* 📦Expose sdist manpage build deps unconditionally
Due to a bug in pypa/build, the `get_requires_for_build_sdist()` hook
is always invoked with `config_settings=None`. This means that we
cannot conditionally extend build requirements in said hook.
As a workaround, this patch makes hook pretend that `--built-manpages`
is always passed.
Ref: https://github.com/pypa/build/issues/559.
---------
Co-authored-by: Matt Davis <6775756+nitzmahone@users.noreply.github.com>
(cherry picked from commit 67bafafbc0)
This is a backport of #80098.
This change allows ansible-test to work with newer versions of git on AZP..
(cherry picked from commit bad8843124)
Co-authored-by: Matt Clay <matt@mystile.com>
Scripts previously under `test/utils/shippable/` are now under `.azure-pipelines/commands/` instead.
(cherry picked from commit f47bc03599)
Co-authored-by: Matt Clay <matt@mystile.com>
- Support loading of vendored Python packages.
- Exclude vendored Python packages from payloads.
(cherry picked from commit 6bfe6b899a)
Co-authored-by: Matt Clay <matt@mystile.com>
Always indicate the Python version being used before installing requirements.
(cherry picked from commit 5e3db6e441)
Co-authored-by: Matt Clay <matt@mystile.com>
Integration test target prefixes defined in a `tests/integration/target-prefixes.{group}` file can now contain an underscore (`_`) character.
(cherry picked from commit e6cffce0eb)
Co-authored-by: Matt Clay <matt@mystile.com>
This patch creates a thin wrapper around the `setuptools`' PEP 517
build backend in-tree. It features an ability to request generating
the manpage files in the process of building a source distribution.
This toggle is implemented using the `config_settings` mechanism of
PEP 517.
One must explicitly pass it a CLI option to the build front-end to
trigger said behavior. The packagers are expected to use the
following call:
python -m build --config-setting=--build-manpages
This option has no effect on building wheels.
🧪 The change includes integration tests
This test runs building and re-building sdists and wheels with and
without the `--build-manpages` config setting under the
oldest-supported and new `setuptools` pinned.
It is intended to preserve the interoperability of the packaging setup
across Python runtimes.
An extra smoke test also verifies that non PEP 517 interfaces remain functional.
PR #79606
Co-authored-by: Matt Clay <matt@mystile.com>
(cherry picked from commit 56036013cd)
* [stable-2.14] ansible-test - Fix pylint error with old home dir (#80151)
(cherry picked from commit 27287b40c0)
Co-authored-by: Matt Clay <matt@mystile.com>
* ansible-test - Fix error with missing pylint home (#80155)
(cherry picked from commit 367d45facd)
* Add Steampunk Spotter to Other tools list (#80006)
(cherry picked from commit 122de95d85)
* Clarify combine filter examples (#80078)
(cherry picked from commit 39fd899d83)
* Add Ansible community 7.3.0 porting guide (#80106)
(cherry picked from commit dbcaab1012)
* Clarify when plugin settings are being populated (#79710)
(cherry picked from commit 998b5c1a06)
* Update playbooks_tests.rst (#79788)
(cherry picked from commit ed879954f9)
* consistent booleans for page text and code blocks (#80036)
* consistent booleans for page text and code blocks
* Update check_mode from n to false
(cherry picked from commit 940fdf5dba)
* Update collection_integration_updating.rst (#80037)
(cherry picked from commit ce5471fc9f)
* package_facts requires python-rpm on SUSE systems in ansible 2.12.1 (#80041)
(cherry picked from commit 43aa47c2af)
* fix: jinja complex type transforms doesn't work as documented (#80067)
jinja complex type transforms: dict(somelist| slice(2)) doesn't work as documented. Changed the example to use zip_longest
(cherry picked from commit 5ad77fc7bb)
* Docs: Clarify note on tags (#80079)
The current wording could be read as "tasks that are tagged *both* configuration and packages" while in fact it is "tasks that are tagged *either* configuration *or* packages"
(cherry picked from commit 563833d124)
* Fix typo docs in playbooks_tags.rst (#80117)
(cherry picked from commit c8f740cfee)
* Encourage true/false for module documentation (#80060)
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 02c49ffe60)
* fix link for development guidelines (#80055)
(cherry picked from commit 012393e2cd)
* improve password lookup syntax in examples (#80092)
(cherry picked from commit 809727a7c7)
* Fixing typos (#80045)
(cherry picked from commit 841b71c94f)
* clarify playbook tests (#80073)
(cherry picked from commit 0521184337)
* Update playbooks_conditionals.rst (#80062)
"changed" was missing from the docs
(cherry picked from commit cc8e6d06d0)
---------
Co-authored-by: Anže Luzar <aluzarwork@gmail.com>
Co-authored-by: Klaus Frank <agowa338@users.noreply.github.com>
Co-authored-by: Anwesha Das <anwesha@das.community>
Co-authored-by: nkakouros <tterranigma@gmail.com>
Co-authored-by: Gijikiki <61326640+Gijikiki@users.noreply.github.com>
Co-authored-by: Aastha Varma <aastha.code@gmail.com>
Co-authored-by: Player256 <92082372+Player256@users.noreply.github.com>
Co-authored-by: Desmond Obisi <51109125+DesmondSanctity@users.noreply.github.com>
Co-authored-by: Raphael Michel <mail@raphaelmichel.de>
Co-authored-by: Nicolas P <0kyn.dev@gmail.com>
Co-authored-by: Kristian Heljas <11139388+kristianheljas@users.noreply.github.com>
Co-authored-by: Akira Yokochi <akira6592@gmail.com>
Co-authored-by: Andreas Deininger <andreas@deininger.net>
Co-authored-by: Keeper-of-the-Keys <es.rosenberg+github@gmail.com>
* don't ignore templated _raw_params that k=v parser failed to parse (#79913)
fixes#79862
(cherry picked from commit e1d298ed61)
* backport test change to runme.sh
* add null 'manifest' key to metadata for git repo collections containing MANIFEST.json
changelog
* set to Sentinel instead of None
* Test installing a collection in a git repo that contains a MANIFEST.json
* fix test
* Update changelogs/fragments/ansible-galaxy-install-git-src-manifest.yml
(cherry picked from commit 321848e98d)
* [Docs] add easyfix/good first issue/docs links (#79830)
(cherry picked from commit 722fc05c31)
* [Docs] add doc links to documentation_contributions.rst (#79840)
(cherry picked from commit 58f0950638)
* Remove dev_guide stubs (#79795)
* Remove dev_guide stubs
* Remove Cisco ACI Dev Guide
(cherry picked from commit 10f0e5f6d4)
* maintainers_guidelines.rst: add a link to collection release guidelines (#79859)
(cherry picked from commit fa382670dc)
* Mentions 'meta: flush_handlers' task (#79542)
(cherry picked from commit d8dc76e134)
* Description for changing User ID to match user value (#79470)
(cherry picked from commit 913e4863af)
* Remove irrelevant line (#79865)
Remove irrelevant comment line form example code
(cherry picked from commit 1c01eab3fb)
---------
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: Mario Lenz <m@riolenz.de>
Co-authored-by: Andrew Klychkov <aklychko@redhat.com>
Co-authored-by: JaroslavKlech <klechh@gmail.com>
Co-authored-by: Tabah Baridule M <dulemartins07@gmail.com>
Co-authored-by: Konrad Gawda <konrad.gawda.opensource@gmail.com>
* fix filename for sidecar docs (#79779)
(cherry picked from commit f2707d1fbc)
* correct examples to use removed_from_collection not collection_name (#79803)
(cherry picked from commit 7ab3de7ee8)
* Fix: documentation for per-task timeout (#79715)
(cherry picked from commit 48e6bf8d27)
* [Docs] maintainers_guidelines: add WG and real-time chat request info (#79750)
(cherry picked from commit 6cb6d655b3)
* doc fix for platform content #79794 (#79801)
(cherry picked from commit d7a4152851)
* Expand docs for the import sanity test. (#79768)
* Expand docs for the import sanity test.
* Remove note about Python 2.7 compat.
It should not be needed since there is a sanity test to enforce use of `__metaclass__ = type`.
* Improve introductory paragraph.
* Fix link typo.
(cherry picked from commit 2164d5699c)
* docs: Extend password entry of ansible.builtin.user (#79694)
* docs: Extend password entry of ansible.builtin.user
Clarify that `password` sets the password hash.
Not the actual password.
Fixes part of #79684
(cherry picked from commit 6cd1a1404a)
* Update dev_guide.rst (#79625)
(cherry picked from commit 65eb5c0a9f)
* Improve documentation on requirements.yml (#76140)
Makes it clear that user can use range identifiers with collection
versions inside requirements.yml files.
(cherry picked from commit 44dcfde9b8)
---------
Co-authored-by: Evgeni Golov <evgeni@golov.de>
Co-authored-by: Jo <jo@swagspace.org>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: prasadpatil49 <51715670+prasadpatil49@users.noreply.github.com>
Co-authored-by: Matt Clay <matt@mystile.com>
Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>
Co-authored-by: Jens Timmerman <github@caret.be>
Co-authored-by: Sorin Sbarnea <ssbarnea@redhat.com>
* Update authentication.rst (#79623)
(cherry picked from commit e7af7532bd)
* Fix typo (#79641)
(cherry picked from commit 8e7cc371be)
* correct the mistake of example repeat_original (#79659)
there is a little mistake
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
(cherry picked from commit 6f8c1da0c8)
* switched reference from katacoda to instruqt (#79698)
(cherry picked from commit 0fc932fda0)
* contributor_path: fix typos (#79678)
(cherry picked from commit fe7d488a1b)
* Fix broken reference to FAQ (#79621)
(cherry picked from commit 602824db1d)
* Docsite: add Security Automation Working Group to Communication guide (#79692)
(cherry picked from commit 65efa4b97f)
* Docsite: remove dead Lockdown Working Group from Communication guide (#79693)
(cherry picked from commit 55f9d7f71f)
* Fix `undef()` example to a valid Jinja template (#79701)
(cherry picked from commit e41d2874a6)
* Truthy value should be one of false or true (#79730)
Otherwise ansible-lint complains: https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.truthy
(cherry picked from commit b756a08d89)
* Fix regex filter docs (#79736)
* Fix notes in regex_replace doc
The documentation says that this maps to 'regex.replace' when it should say 're.replace'. The distinction is important because of the third-party 'regex' module that has more features than the built-in 're' module. https://pypi.org/project/regex/
* Fix notes in re.search docs
The documentation says that this maps to 'regex.search' when it should say 're.search'. The distinction is important because of the third-party 'regex' module that has more features than the built-in 're' module. https://pypi.org/project/regex/
(cherry picked from commit cf50d8131f)
* complex_data_manipulation.rst: fix typo (#79758)
(cherry picked from commit b5b7f9bce2)
* Fix broken link for inventory script examples (#79762)
These scripts were removed from community.general in https://github.com/ansible-collections/community.general/pull/2696 and moved to ansible-community/contrib-scripts per https://github.com/ansible-community/community-topics/issues/16#issuecomment-853317111
(cherry picked from commit 97993eeb10)
* communication.rst: improve (#79751)
(cherry picked from commit 11a27eefa2)
* Fix broken docs links. (#79769)
(cherry picked from commit 5d71ace583)
Co-authored-by: Gineesh Madapparambath <net.gini@gmail.com>
Co-authored-by: Kristopher Henry Kram <kristopher@kristopherkram.com>
Co-authored-by: evangelionlion <546620084@qq.com>
Co-authored-by: Deric Crago <deric.crago@gmail.com>
Co-authored-by: Andrew Klychkov <aklychko@redhat.com>
Co-authored-by: Rune Juhl Jacobsen <rune@juhljacobsen.dk>
Co-authored-by: Kristian Heljas <11139388+kristianheljas@users.noreply.github.com>
Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>
Co-authored-by: antonc42 <antonc42@users.noreply.github.com>
Co-authored-by: Kenyon Ralph <kenyon@kenyonralph.com>
Co-authored-by: Matt Clay <matt@mystile.com>
* Normalize deprecation records.
* Fix alias deprecations in suboptions.
* Report in which option an alias warning happened for suboptions.
* Add deprecation tests for suboptions.
* Also test deprecation in list of dicts.
* Adjust unit tests for toplevel alias deprecation field name change.
(cherry picked from commit 8a7185c224)
Sloane Hertel