summaryrefslogtreecommitdiffstats
path: root/awx_collection/README.md
diff options
context:
space:
mode:
authorAlanCoding <arominge@redhat.com>2020-03-04 02:19:41 +0100
committerAlanCoding <arominge@redhat.com>2020-03-04 02:19:41 +0100
commit85ec73bf4beb5ee66ba2d876d9147816a945c0a2 (patch)
tree49b020ef5d25fd61af7fc352dfd5bf1df7e407a1 /awx_collection/README.md
parentMerge pull request #6129 from squidboylan/collection_integration_tests (diff)
downloadawx-85ec73bf4beb5ee66ba2d876d9147816a945c0a2.tar.xz
awx-85ec73bf4beb5ee66ba2d876d9147816a945c0a2.zip
Unify collection targets for install and ansible-test
Diffstat (limited to '')
-rw-r--r--awx_collection/README.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/awx_collection/README.md b/awx_collection/README.md
index f91396e59c..26b17ca268 100644
--- a/awx_collection/README.md
+++ b/awx_collection/README.md
@@ -8,6 +8,15 @@ inside the folder `lib/ansible/modules/web_infrastructure/ansible_tower`
as well as other folders for the inventory plugin, module utils, and
doc fragment.
+## Building and Installing
+
+This collection templates the `galaxy.yml` file it uses.
+Run `make build_collection` from the root folder of the AWX source tree.
+This will create the `tar.gz` file inside the `awx_collection` folder
+with the current AWX version, for example: `awx_collection/awx-awx-9.2.0.tar.gz`.
+
+Installing the `tar.gz` involves no special instructions.
+
## Release and Upgrade Notes
The release 7.0.0 of the `awx.awx` collection is intended to be identical
@@ -95,12 +104,6 @@ cd ~/.ansible/collections/ansible_collections/awx/awx/
ansible-test integration
```
-## Building
-
-The build target `make build_collection` will template out a `galaxy.yml` file
-with automatic detection of the current AWX version. Then it builds the
-collection with the `ansible-galaxy` CLI.
-
## Licensing
All content in this folder is licensed under the same license as Ansible,