search

ansible / mazer

Experimental Ansible Galaxy Content Manager
GNU General Public License v3.0
114 stars 18 forks source link

Add info about editable mode to README #162

Closed alikins closed 5 years ago

alikins commented 5 years ago

Installing collections in 'editable' mode for development

To enable development of collections, it is possible to install a local checkout of a collection in 'editable' mode. Instead of copying a collection into ~/.ansible/content, this mode will create a symlink from _~/.ansible/content/my_namespace/mycolllection to a dir where the under development collection lives.

ie, if _~/src/collections/my_newcollection is being worked on, to install it in editable mode under the namespace 'my_namespace' :

$ mazer install --namespace my_namespace --editable _~/src/collections/my_new_collection_

The above command will symlink _~/.ansble/content/my_namespace/my_newcollection -> _~/src/collections/my_newcollection.

The install option '--editable' or the short '-e' can be used. Note that '--namespace' option is required.

ISSUE TYPE