release 1.0.0 (#22)

cmeissner · web-flow · commit 4af4fbfac3d5 · 2020-10-30T17:53:28.000+01:00
* Fix some issues coming from changes in `phpypam`

As the parameters for methods of `phpypam.api` had changed we need to do
some adjustances here too.
For this reason we need to use `phpypam` from version 1.0.0 or above
from now.

* Publish workflow

Add github workflow to auto publish new versions to ansible galaxy.
Rename requirements to be consistent with other projects of `codeaffen`.

* Adapt documentation to meet dependencies

Add requirement of version for `phpypam` to documentation.

* prepare release
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,26 @@
+name: Release Ansible collection
+
+on:
+  push:
+    tags:
+      - v[0-9]+\.[0-9]+\.[0-9]+
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+    - name: Build and publish
+      env:
+        GALAXY_API_KEY: ${{ secrets.GALAXY_API_KEY }}
+      run: make publish
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,16 @@ codeaffen.phpipam Release Notes
 .. contents:: Topics
 
 
+v1.0.0
+======
+
+Major Changes
+-------------
+
+- Adapt documentation to reflect the final requirements
+- Running tests against the new version and do some changes to work as expected
+- Switch to stable version of `phpypam` module
+
 v0.5.0
 ======
 
diff --git a/README.md b/README.md
@@ -120,7 +120,7 @@ OPTIONS (= is mandatory):
         type: str
 
 
-REQUIREMENTS:  inflection, ipaddress, phpypam
+REQUIREMENTS:  inflection, ipaddress, phpypam>=1.0.0
 
 AUTHOR: Christian Meißner (@cmeissner)
         METADATA:
@@ -161,4 +161,4 @@ The following dependencies have to be fulfiled by the Ansible controller.
 
 * inflection
 * ipaddress
-* phpypam
+* phpypam>=1.0.0
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -35,3 +35,12 @@ releases:
       name: device_type
       namespace: ''
     release_date: '2020-10-29'
+  1.0.0:
+    changes:
+      major_changes:
+      - Adapt documentation to reflect the final requirements
+      - Running tests against the new version and do some changes to work as expected
+      - Switch to stable version of `phpypam` module
+    fragments:
+    - finally_go_stabel.yml
+    release_date: '2020-10-30'
diff --git a/docs/plugins/address_module.rst b/docs/plugins/address_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/docs/plugins/device_module.rst b/docs/plugins/device_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/docs/plugins/device_type_module.rst b/docs/plugins/device_type_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/docs/plugins/domain_module.rst b/docs/plugins/domain_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/docs/plugins/nameserver_module.rst b/docs/plugins/nameserver_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/docs/plugins/section_module.rst b/docs/plugins/section_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/docs/plugins/subnet_module.rst b/docs/plugins/subnet_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/docs/plugins/vlan_module.rst b/docs/plugins/vlan_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/docs/plugins/vrf_module.rst b/docs/plugins/vrf_module.rst
@@ -55,7 +55,7 @@ The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam
+- phpypam>=1.0.0
 
 
 .. Options
diff --git a/galaxy.yml b/galaxy.yml
@@ -3,7 +3,7 @@ name: "phpipam"
 description: Ansible Modules to manage phpIPAM installations
 authors:
   - "Christian Meißner <cme+ansible@meissner.sh>"
-version: "0.5.0"
+version: "1.0.0"
 license:
   - "GPL-3.0-or-later"
 tags:
diff --git a/plugins/doc_fragments/phpipam.py b/plugins/doc_fragments/phpipam.py
@@ -24,7 +24,7 @@ class ModuleDocFragment(object):
 requirements:
     - inflection
     - ipaddress
-    - phpypam
+    - phpypam>=1.0.0
 options:
     server_url:
         description: URL of the phpIPAM server
diff --git a/plugins/module_utils/phpipam_helper.py b/plugins/module_utils/phpipam_helper.py
@@ -323,7 +323,7 @@ def _sanitize_entity(self, entity):
     def _create_entity(self, desired_entity):
 
         try:
-            self.phpipamapi.create_entity(self.controller_uri, desired_entity)
+            self.phpipamapi.create_entity(self.controller_uri, data=desired_entity)
             self.set_changed()
             entity = self.find_current_entity()
         except PHPyPAMEntityNotFoundException:
@@ -359,7 +359,7 @@ def _update_entity(self, desired_entity, current_entity):
         else:
             update_path = '/'
 
-        self.phpipamapi.update_entity(self.controller_uri, updated_entity, controller_path=update_path)
+        self.phpipamapi.update_entity(self.controller_uri, update_path, updated_entity)
 
         try:
             entity = self.find_current_entity()
diff --git a/requirements-dev.txt b/requirements-dev.txt
