Commit graph

25 commits

Author SHA1 Message Date
Sviatoslav Sydorenko
6abeabaff1 Fix versionadded syntax @ galaxy user guide 2021-01-25 12:08:52 +01:00
Abhijeet Kasurde
25792d2388
galaxy: handle plus sign in user token appearing in role url ()
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-01-06 10:50:44 -05:00
Abhijeet Kasurde
776274143f
galaxy: Update example for git+file ()
Use correct syntax for installation of role from
local git repository.

Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-01-04 12:01:54 -05:00
Jamie Wark
7eee2454f6
Remove note on combining roles and collections () 2020-12-15 09:18:14 -06:00
Alicia Cozine
e5ccd18be4
Wording changes to docs () 2020-12-08 16:46:34 -05:00
Sorin Sbarnea
787e6108e0
Document galaxy install from local clones () 2020-07-28 14:05:28 -04:00
Baptiste Mille-Mathias
92e16c2838
Few fixes for reference_appendices/faq.html ()
* Format using `` instead of `, add line breaks for long lines, rephrase or remove useless text.
Move some text.

* Add clearer version of OpenSSh is affected by SCP bug

* Review some pages using ansible doc writing guide.
2020-07-20 13:43:39 -05:00
Sloane Hertel
e40889e711
Add support to install collections from git repositories ()
* Enable installing collections from git repositories

* Add tests for installing individual and multiple collections from git repositories

* Test to make sure recursive dependencies with different syntax are deduplicated

* Add documentation

* add a changelog

* Skip Python 2.6

* Only fail if no collections are located in a git repository

Add support for a 'type' key for collections in requirement.yml files.
Update the changelog and document the supported keys and allowed values for the type.

Add a note that the collection(s) in the repo must contain a galaxy.yml

* Add a warning about embedding credentials in SCM URLs

* Update with review suggestions

* suppress sanity compile failure for Python 2.6
2020-05-29 13:33:32 -04:00
Alexandre Chouinard
91bb5af688
Update ansible-galaxy to handle role requirements ()
* Update galaxy role object to handle requirements

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2020-04-28 10:42:57 -04:00
Tomáš Pospíšek
ddef49bb7f
correctly escape parameters with dashes () 2020-03-25 14:49:05 -04:00
TAKAHASHI Shuuji
b950d18912
Add an example of specifying a specific commit hash. () 2020-02-25 10:40:12 -05:00
Sandra McCann
8fbec3cdeb
add download tarball option () 2020-02-24 16:30:34 -06:00
Sam Doran
6c70959131
Update example requirements file docs ()
Use "name" when possible rather than "src" to make the examples
of roles and collections in a single requirements files more
coherenant. Fundamentally, roles and collections are completely different.
But we can make the requiremets file easier to read by unifying the
format as much as possible.
2020-02-24 14:37:10 -05:00
Andrew Klychkov
ad8df69b58
docs/docsite/rst/: fix typos () 2020-02-21 10:57:07 +00:00
Sam Doran
f506fd4730
Add ansible-galaxy collection list command ()
* Start adding ansible-galaxy collection list options

* Working list all collections and list a specific collection

* Nuke debugging cruft

* Use to_text to get a string of the FQCN for sorting

* Improve collection output formatting

- add header
- display collection name and version in separate columns
- width of columns is dynamic based on collection name and version length

* Make role list output match collection output list

- add header
- add columns for role name and version
- make column width dynamic based on name and version length

* remove debug statemnt and extra header

* Revert "Make role list output match collection output list"

This reverts commit a0b3db47bb3b198aafd34c1f1be5b6561af2f928.

* Add validate_collection_path function

Utility function for ensuring a collection target ends with 'ansible_collection'

* Use validate_collection_path

* Do not warn if a specific collection in found in any search path

* Fix extraneous warning and remove duplicate code

Do not warn when listing a specific collection and it does not exist
in other collection paths.

Restructure the code that loops through collection paths to remove
duplicate conditional code.

* Indicate role path was found

* Use new function name

* WIP Save Point

* Use separate functions for role and collection list

* Wrap error message

There may be a better way to do this besides hard coding a line break, but this
does make the message a lot more readable.

* Add validate_collection_path function ()

* Add validate_collection_path function

Utility function for ensuring a collection target ends with 'ansible_collection'

* Fix bad syntax

* Correct docstring

* Bikeshed the names

* Properly list a single role

* Simplify _display_warnings()

Only display warnings. Move exception raise back to each caller.

* Move private methods to private functions

They don't need self, so it makes sense to have them as functions
Get rid of _display_warnings() function since it doesn't do anything worthy of
an independent function.

* Add integration tests for ansible-galaxy collection list

* Fix docs sanity test

* Fix bug where ansible_collections dir does not exist

The path may exist, but if there is no ansible_collections dir inside that path,
an exception was raised in find_existing_collections().

Add integration test for this scenario

* Put execute_list() method back

* Add some informational messages for debugging

* Add unit tests

Units tests for the various private methods in support of collection list

* Start adding unit tests for test_execute_list

* Display collection path when listing specific collection

* Add unit tests for listing all collections and specific collection

- Create fixture for creating test objects
- Add function for controlling os.path.isdir results

* Set defaults for minimum collection widths

Ensure that collections with small FQCNs display correctly.
Add unit tests

* Split up unit tests and fix fixtures

Add more fixtures for mocking objects during the specific collection tests

* Change help message for -p in list subcommand

Give accurate description of what it actually does rather than trying to use language shared between sub commands.

* Disable colorized output in unit test

* Add docs for collection list

* Fix integration test on macOS

The temp file path is really long on macOS, so the warning message gets wrapped
across multiple lines. That make seth grep fail. Switch to matching on a smaller
part of the warning.

* Recreate common path options for collections

Improve help about what the '-p' option does and how it works.

* Remove unnecessary elif after continue statements

* Account for duplicate paths in collections_searh_paths

If someone specifies the same path via '-p' that is the COLLECTIONS_PATHS,
do not list the collections twice.

* Docs updates
2020-02-14 14:00:00 -06:00
Sandra McCann
80dff8743a fixed some broken links () 2020-01-06 10:24:07 -06:00
Sandra McCann
5eceebcaf3 Clarify how to install roles and collections from same requirements file () 2019-12-11 10:21:41 -06:00
Sandra McCann
2749090bc6 fix collection broken links () 2019-11-18 13:50:23 -06:00
Baptiste Mille-Mathias
1d0a832692 Fix link to Roles () 2019-11-18 12:05:18 -05:00
Baptiste Mille-Mathias
f198036d7f Remove duplicated and broken link to Roles () 2019-11-18 12:04:38 -05:00
Alicia Cozine
1df62f129a Collections versions () 2019-11-18 09:31:29 -05:00
Sandra McCann
a01376a493 update configuring ansible-galaxy client ()
* update configuring ansible-galaxy client, deduplicate, clarify tokens, AH procedures, etc.
2019-11-15 09:49:51 -06:00
Sandra McCann
ee8a088205 combine galaxy.com install roles details ()
* combine galaxy.com install roles details
* flatten dev guide and user guide for galaxy
2019-10-28 14:59:14 -05:00
Amrita42
7a8c909876 Enter should be Italics as it is a menu option () 2019-10-14 11:04:05 -04:00
Sandra McCann
ae265bc546 Move galaxy appendix info to a new Galaxy section ()
* start galaxy docs restructure
* shared snippets in txt files
* moved all content to galaxy section
2019-10-11 13:19:44 -05:00