-
Notifications
You must be signed in to change notification settings - Fork 23.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Extend dev guide for collection testing and collection hacking #68899
Conversation
…), and fix itemization.
|
||
To run all compile and sanity tests, execute:: | ||
|
||
ansible-test sanity --docker default --color -v |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd omit the --color
option, as it's normally auto-detected for interactive use. It should only be needed when piping stdout or on CI systems which do not report stdout as a TTY.
ansible-test sanity --docker default --color -v | |
ansible-test sanity --docker default -v |
The same applies to the other examples below.
I'd also consider using --docker
instead of --docker default
(but with a note mentioning that using a non-option after it will be seen as a container name).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll remove --color
then.
I included default
after --docker
to avoid that when people remove --color -v
, it suddenly reports "strange" errors when they list an explicit target.
This is great, thank you @felixfontein!! 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome documentation addition, thank you!
Co-Authored-By: Felix Fontein <felix@fontein.de>
|
||
Now you can use this checkout of ``community.general`` in playbooks and roles with whichever version of Ansible you have installed locally, including a local checkout of the ``devel`` branch. | ||
|
||
For collections hosted in the ``ansible_collections`` GitHub org, create a branch and commit your changes on the branch. When you are done (remember to add tests, see :ref:`testing_collections`), push your changes to your fork of the collection and create a Pull Request. For other collections, especially for collections not hosted on GitHub, check the ``README.md`` of the collection for information on contributing to it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For collections hosted in the ``ansible_collections`` GitHub org, create a branch and commit your changes on the branch. When you are done (remember to add tests, see :ref:`testing_collections`), push your changes to your fork of the collection and create a Pull Request. For other collections, especially for collections not hosted on GitHub, check the ``README.md`` of the collection for information on contributing to it. | |
For collections hosted in the ``ansible-collections`` GitHub org, create a branch and commit your changes on the branch. When you are done (remember to add tests, see :ref:`testing_collections`), push your changes to your fork of the collection and create a Pull Request. For other collections, especially for collections not hosted on GitHub, check the ``README.md`` of the collection for information on contributing to it. |
It's https://github.com/ansible-collections/ with a dash.
Thanks everyone for reviewing and your comments, and especially @acozine for heavily improving it! |
SUMMARY
This extends the dev guide with details for working with collections:
Also contains three tiny only somewhat related improvements:
/rebuild
and/rebuild_failed
(141d2c2), CC @jctanner;CC @gundalow @maxamillion @mattclay
ISSUE TYPE
COMPONENT NAME
docs/docsite/rst/dev_guide/developing_collections.rst
docs/docsite/rst/dev_guide/testing_compile.rst
docs/docsite/rst/dev_guide/testing.rst