Commit Graph

105 Commits

Author SHA1 Message Date
林博仁 Buo-ren Lin
dce75072fa many: Fix title case of Git references (#1938)
* many: Fix title case of Git references

Currently many references of the Git software don't use title case, this
patch fixes them while leaving those that should remain lowercase
intact:

* `git` command call in code blocks.
* Git references in changelog entries should stay consistent with the revision title.

Fixes #1935.

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>

* Update docs/docsite/rst/dev_guide/testing_integration.rst

Fix command markup.

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update hacking/README.md

Also fix title case of Python.

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2024-09-25 07:32:34 +02:00
Andrew Klychkov
bf86a30bef Replace communication links with a link to communication guide, part 2 (#1864)
* 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>
2024-09-12 09:41:36 +02:00
Sumanth Lingappa
940152cdf7 added gather_facts/(yes/no) (#1003)
* added `gather_facts/(yes/no)`

Co-authored-by: Don Naro <dnaro@redhat.com>
2024-01-15 14:27:57 -05:00
Matt Clay
de9e1e522e Update shebang sanity test docs to match test (#677)
The `#!/bin/bash` shebang was removed in https://github.com/ansible/ansible/pull/50954, but the documentation was never updated to reflect the change.
2023-10-23 10:46:58 +01:00
Brian Coca
9339f71d3f corrected cli for help (#599)
this prevents an error, but it does not really matter as -h
  will return generic help for ansible-test and not specific to
  a test.
2023-10-13 11:06:05 -04:00
Matt Clay
95b63d7bdb Update sanity test docs for devel (#520) 2023-10-05 10:37:39 -04:00
Biresh Biswas
8f085111b4 Replacing filename with file name (#502) 2023-10-04 16:36:20 -04:00
zu
b5721a84cd Replace controller with control node (#352)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
2023-09-13 15:45:05 -04:00
zukkie
aef2d315e3 [issues #78]Update collection requirements links (#306)
* [issues #78]Update collection requirements links

* [fix]Change checklist to requirements
2023-08-21 20:35:12 +02:00
Matt Clay
737a14cefb Add a FAQ for the import sanity test (#294)
While the answers are somewhat repetitive, they will hopefully assist users who are struggling with resolving errors from this test.

This FAQ is based on questions from actual users.
2023-08-17 15:26:40 -04:00
Matt Clay
702dcac7ea Update the package-data sanity test docs (#229) 2023-08-03 13:24:35 -07:00
Matt Clay
acea1a0911 Fix sanity test page titles (#228)
The titles should exactly match the name of the sanity test.
2023-08-03 13:07:43 -07:00
Martin Krizek
1a04792ff3 Remove botmeta sanity test from the core tests list (#119)
Fixes #114
2023-07-14 17:13:31 -04:00
Matt Clay
e9d580384f Update sanity test documentation (#99)
* Update list of available sanity tests

* Add a page for the new pymarkdown sanity test

* Mark orphan sanity test pages
2023-07-12 21:48:45 +01:00
Matt Clay
aec0ca27a1 Make sanity index static (#2) 2023-06-09 21:35:15 -07:00
Brian Coca
19b85ff415 have docs explain why we import guard (#80569)
Co-authored-by: Matt Clay <matt@mystile.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
2023-05-18 16:38:30 -04:00
Jordan Borean
0a36cd910e Removed testing support for Server 2012 and 2012 R2 (#80778) 2023-05-18 11:02:58 -07:00
Matt Clay
560d5b00d0 Remove docs references to obsolete test plugins (#80576) 2023-04-19 14:40:58 -07:00
Matt Clay
1d6f019ce6 Remove obsolete integration test aliases (#80342)
* Remove obsolete integration test aliases

* Remove obsolete `skip/osx` aliases

* Use `skip/macos` instead of `skip/osx` in docs
2023-03-28 13:45:56 -07:00
Felix Fontein
4ea50cef23 validate-modules: check_mode attribute and compare with supports_check_mode parameter (#80090)
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
2023-03-23 09:59:33 -07:00
Matt Martz
24519f3bd1 Update example to always init ANOTHER_LIBRARY_IMPORT_ERROR (#79927) 2023-02-06 13:44:10 -06:00
Matt Clay
2164d5699c 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.
2023-01-26 12:38:26 -08:00
Matt Clay
a3b7863098 validate-modules - Remove __future__ limits (#79800)
* validate-modules - Remove `__future__` limits

Limits on specific `__future__` imports are handled by other sanity tests.

* Add integration test for module/plugin imports.
2023-01-24 13:25:32 -08:00
Matt Clay
eae02bf5b8 Fix link in compile sanity test docs. 2023-01-04 18:34:12 -08:00
Matt Clay
932a32153a Update docs for the compile sanity test. (#79562) 2022-12-08 16:05:44 -05:00
Matt Clay
cda16cc5e9 ansible-test - Improve container management. (#78550)
See changelogs/fragments/ansible-test-container-management.yml for details.
2022-11-29 13:35:53 -08:00
Sandra McCann
a954918b60 consolidate duplicated test files (#79380) 2022-11-17 16:20:20 -05:00
Mazen Ramadan
fbd98cd824 Docs: Replace Latin terms in the dev_guide #78997 (#79005) 2022-10-03 16:42:37 -04:00
Blaster4385
f7c01bc866 Docs: Provide descriptive labels for http references (#78959) 2022-10-03 15:01:27 -04:00
Luigi Giugliano
9afb37eda6 #78965 Adding the code-block to prevent the translation (#78979)
* Adding the code-block to prevent the translation
2022-10-01 11:40:28 -07:00
Muhammad Rafly Andrianza
0f688f07af update the out-of-date ansible-test sanity ignores (#78342) 2022-07-27 09:33:35 -07:00
Matt Clay
3d5637beec Initial mypy sanity test support for core. 2022-03-08 09:26:14 -08:00
Sandra McCann
af7c9deb4e add crosslinks for changelog fragments (#77022) 2022-02-15 02:40:50 -08:00
Jordan Borean
7dd22b8b4b Update Windows host requirements (#76582) 2021-12-20 13:43:01 -05:00
Matt Clay
bb63c97c16 ansible-test - Update import test and sanity requirements. (#76308)
* Add script to freeze sanity requirements.
* Declare sanity test requirements and freeze
* Use pinned requirements for import.plugin test.
* Expand scope of import test for ansible-core.
* Add ignores for galaxy import errors.
* Update test-constraints sanity test.
2021-11-16 18:16:42 -08:00
Samuel Gaist
19fce0527a docs - Use code-block to format code examples in Developer Guide (#75849)
Fixes #75663
2021-10-04 13:55:00 -07:00
Matt Clay
4ea8d9a782 ansible-test - split controller/target testing (#75605) 2021-09-20 18:39:07 -07:00
Aine Riordan
17122edfc5 Docs: Fix section header notation in Developer Guide (#75721) 2021-09-17 10:52:46 -04:00
Erik Zettel
c2fa71c4e8 Fix various typos in documentation (#75662)
* docs/docsite/rst/dev_guide/developing_modules_general_aci.rst: fix typos

* docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst: fix typos

* docs/docsite/rst/dev_guide/testing_units_modules.rst: fix typos

* docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.0.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.10.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.4.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_3.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_4.rst: fix typos

* docs/docsite/rst/reference_appendices/glossary.rst: fix typos

* docs/docsite/rst/reference_appendices/release_and_maintenance.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/collect_information.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/vm_tool_information.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos

* docs/docsite/rst/user_guide/playbooks_debugger.rst: fix typos

* docs/docsite/rst/user_guide/playbooks_filters.rst: fix typos

* docs/docsite/rst/user_guide/windows_performance.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos
2021-09-09 08:34:46 -07:00
Matt Clay
99a79e1969 ansible-test - Move code from _data to _util. (#75495)
* Update paths to match relocated files.
* Update ansible-test symlink paths.
* Update path classification.
* Update MANIFEST.in
* Update sanity test context paths.
* Update sanity ignores.
* Update shebang sanity test.
* Update configure-remoting-ps1 sanity test.
* Update BOTMETA.yml to reflect new paths.
* Update paths in collection loader comments.
* Update Makefile for ansible-test.
* Update docs.
* Add changelog fragment.
2021-08-12 15:07:06 -07:00
Alicia Cozine
3c3e30a610 Docs: Add Matrix as a chat option (#75406) 2021-08-12 11:47:02 -04:00
Mark Mercado
1906d75907 Adding DigitalOcean cloud support to ansible-test (#74222) 2021-05-12 16:07:21 -07:00
schurzi
5e5bfa8116 remove deprecated ansible.module_utils._text from documentation (#73211)
According to comment in ansible.module_utils._text it is deprecated and
should not be used. This is now reflected in the documentation.
2021-04-20 11:53:27 -04:00
Alicia Cozine
b57444af14 Rebased pr73824 (#73934)
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-03-17 16:07:38 -04:00
Felix Fontein
3cc693b92c Import test: improve docs, add more tests (#73600) 2021-03-01 16:10:46 -08:00
Felix Fontein
1f3a90270b Import sanity test for plugins (#72497) 2021-02-12 14:09:50 -08:00
John R Barker
37785255f2 validate ansible-base's and collections runtime.yml (#69742)
* Validate ansible-base & collection's runtime.yml

Add new test `runtime-metadata`

* Schema validation of file
* Error if a a legacy meta/routing.yml exist in a collection
* removal_date OR removal_version

* Add tombstone validation.

* Allow both ISO 8601 date strings and datetime.date objects (from YAML dates).

* Address review comments.

* Add metadata to test collection.

* Add requirements file.

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Matt Clay <matt@mystile.com>
2020-06-12 15:34:34 +01:00
Felix Fontein
a114da80ee Use antsibull-changelog instead of packaged changelog generator (#69313)
Replace the ansible-base changelog linting and generation tool with antsibull-changelog and make it available for linting collections. Previously changelog linting was limited to ansible-base.
2020-06-11 11:21:21 -07:00
Matt Davis
ed9de94ad9 remove azure extras and extras_require support (#67822)
* remove azure extras and extras_require support

* Since Azure will be collectionized, the requirements will float more frequently than Ansible releases; the Azure collection needs to host the requirements now.
* Removed the dynamic extras support as well, since Azure was the only thing using it. If we need it again, it's easy to pull back from history.

* Mark azure-requirements as orhpaned.

This keeps the docs around so that existing links from old test runs remain valid.

Co-authored-by: Matt Clay <matt@mystile.com>
2020-03-23 13:07:33 -07:00
Andrew Klychkov
907c98ebcd /docs/docsite/rst/dev_guide: fix typos (#67643) 2020-02-21 10:56:12 +00:00