feat!: rename collection to upcloud.cloud and inventory plugin to servers (#20)

Author: kangasta

.github/workflows/build-and-release.yml

@@ -5,9 +5,9 @@ on:
       - "v*"
 
 env:
-  NAMESPACE: community
-  COLLECTION_NAME: upcloud
-  ANSIBLE_VERSION: stable-2.15
+  NAMESPACE: upcloud
+  COLLECTION_NAME: cloud
+  ANSIBLE_VERSION: stable-2.18
 
 jobs:
   units:
@@ -30,9 +30,14 @@ jobs:
         run: mkdir release && ansible-galaxy collection build --output-path release/
 
       - name: Create new release
-        uses: ncipollo/release-action@v1
+        uses: ncipollo/release-action@v1.16.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           draft: false
           prerelease: false
           artifacts: "release/${{env.NAMESPACE}}-${{env.COLLECTION_NAME}}*.tar.gz"
+
+      - name: Upload release to Ansible Galaxy
+        uses: artis3n/ansible_galaxy_collection@v2.11.0
+        with:
+          api_key: ${{ secrets.GALAXY_TOKEN }}

.github/workflows/sanity-test.yml

@@ -4,19 +4,20 @@ on:
     branches:
       - main
   pull_request:
+
 env:
-  NAMESPACE: community
-  COLLECTION_NAME: upcloud
+  NAMESPACE: upcloud
+  COLLECTION_NAME: cloud
 
 jobs:
   sanity:
     name: Sanity test (${{ matrix.version.ansible }})
     strategy:
       matrix:
         version:
-          - { ansible: stable-2.13, python: "3.10" }
-          - { ansible: stable-2.14, python: "3.11" }
-          - { ansible: stable-2.15, python: "3.11" }
+          - { ansible: stable-2.16, python: "3.11" }
+          - { ansible: stable-2.17, python: "3.11" }
+          - { ansible: stable-2.18, python: "3.11" }
           - { ansible: devel, python: "3.11" }
     runs-on: ubuntu-latest
     steps:

.github/workflows/unit-tests.yml

@@ -6,8 +6,8 @@ on:
   pull_request:
 
 env:
-  NAMESPACE: community
-  COLLECTION_NAME: upcloud
+  NAMESPACE: upcloud
+  COLLECTION_NAME: cloud
 
 jobs:
   units:
@@ -17,9 +17,9 @@ jobs:
       fail-fast: true
       matrix:
         version:
-          - { ansible: stable-2.13, python: "3.10" }
-          - { ansible: stable-2.14, python: "3.11" }
-          - { ansible: stable-2.15, python: "3.11" }
+          - { ansible: stable-2.16, python: "3.11" }
+          - { ansible: stable-2.17, python: "3.11" }
+          - { ansible: stable-2.18, python: "3.11" }
           - { ansible: devel, python: "3.11" }
 
     steps:

CHANGELOG.md

@@ -7,7 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
----
+### Changed
+
+- **Breaking**: Rename collection to `upcloud.cloud` to enable releasing to Ansible Galaxy.
+- **Breaking**: Rename inventory plugin to `servers`.
 
 ## [0.6.0] - 2023-09-25
 

README.md

@@ -7,7 +7,7 @@
 UpCloud inventory as a modernized Ansible collection. Current scope only covers UpCloud's servers offering,
 but depending on the demand we might include our other services (networks, (object) storages, routers, databases etc)
 in it as well. Same goes for plugins for other API actions. We recommend using
-[Terraform](https://upcloud.com/community/tutorials/get-started-terraform/) for automated management of your UpCloud
+[Terraform](https://upcloud.com/docs/guides/get-started-terraform/) for automated management of your UpCloud
 infrastructure, but we might implement some server control plugins for Ansible in the future if the demand is there.
 
 If you find yourself needing a specific service as an inventory, please open an
@@ -41,7 +41,7 @@ servers based on their zone, tags, state, or the network they belong to.
 Create an `upcloud.yml` file with these contents:
 
 ```yaml
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 ```
 
 Set environment variables for API authentication:
@@ -64,7 +64,7 @@ You should see a list of hosts and their host variables you can use in playbooks
 You can filter based on multiple data points:
 
 ```yaml
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 zones:
   - fi-hel2
 labels:
@@ -80,7 +80,7 @@ server_group: Group name or UUID
 Servers can also be grouped by status, zone etc by specifying them as `keyed_groups`.
 
 ```yaml
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 keyed_groups:
   - key: zone
     prefix: upcloud_zone
@@ -92,7 +92,7 @@ Examples here assume that API credentials are available as environment variables
 (`UPCLOUD_USERNAME` & `UPCLOUD_PASSWORD`). They can also be defined in inventory file:
 
 ```yaml
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 username: YOUR_USERNAME
 password: YOUR_PASSWORD
 ```
@@ -108,7 +108,7 @@ enabled:
 collections_paths = ~/.ansible/collections:/usr/share/ansible/collections
 
 [inventory]
-enable_plugins = community.upcloud.upcloud
+enable_plugins = upcloud.cloud.servers
 ```
 
 Note that, if you are using any other plugins, those should be listed in `enable_plugins` as well.

examples/inventory-rolling-update/ansible.cfg

@@ -3,4 +3,4 @@ host_key_checking = False
 inventory = ./inventory.upcloud.yml
 
 [inventory]
-enable_plugins = community.upcloud.upcloud
+enable_plugins = upcloud.cloud.servers

examples/inventory-rolling-update/inventory.upcloud.yml

@@ -1,2 +1,2 @@
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 server_group: ansible-inventory-example-servergroup

galaxy.yml

@@ -1,17 +1,18 @@
-namespace: community
-name: upcloud
-version: 0.6.0
+namespace: upcloud
+name: cloud
+version: 0.7.0
 readme: README.md
 authors:
   - UpCloud developers (github.com/UpCloudLtd)
 description: A collection for managing UpCloud resources & inventory
-license: MIT
+license:
+- MIT
 license_file: 'LICENSE'
 tags:
   - upcloud
   - cloud
 
 repository: https://github.com/UpCloudLtd/upcloud-ansible-collection
-documentation: TODO
+documentation: https://github.com/UpCloudLtd/upcloud-ansible-collection
 homepage: https://github.com/UpCloudLtd/upcloud-ansible-collection
 issues: https://github.com/UpCloudLtd/upcloud-ansible-collection/issues

plugins/inventory/upcloud.py plugins/inventory/servers.pyplugins/inventory/upcloud.py renamed to plugins/inventory/servers.py

@@ -1,10 +1,11 @@
 __metaclass__ = type
 
 DOCUMENTATION = r'''
-    name: upcloud
+    name: servers
     author:
       - Antti Myyrä (@ajmyyra)
-    short_description: Ansible dynamic inventory plugin for UpCloud.
+      - UpCloud (@UpCloudLtd)
+    short_description: Ansible dynamic inventory plugin for UpCloud servers.
     requirements:
         - python >= 3.7
         - upcloud-api >= 2.5.0
@@ -17,7 +18,7 @@
         plugin:
             description: The name of the UpCloud Ansible inventory plugin
             required: true
-            choices: ["community.upcloud.upcloud"]
+            choices: ["upcloud.cloud.servers"]
         username:
             description: UpCloud API username.
             required: false
@@ -82,10 +83,10 @@
 
 EXAMPLES = r"""
 # Minimal example. `UPCLOUD_USERNAME` and `UPCLOUD_PASSWORD` are available as environment variables.
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 
 # Example with username and password
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 username: YOUR_USERNAME
 password: YOUR_PASSWORD
 zones:
@@ -95,7 +96,7 @@
   - foo
 
 # Example with locations, labels and server_group
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 zones:
   - es-mad1
   - fi-hel2
@@ -106,7 +107,7 @@
 
 # Group by a zone with prefix e.g. "upcloud_zone_us-nyc1"
 # and state with prefix e.g. "server_state_running"
-plugin: community.upcloud.upcloud
+plugin: upcloud.cloud.servers
 keyed_groups:
   - key: zone
     prefix: upcloud_zone