Managing_contributors (#58)

cmeissner · web-flow · commit 53a31c755b44 · 2021-11-22T11:36:45.000+01:00
* Managing authors list
* add mailmap for merging different author emails to one main email
* add list to collection manifest
* add new doc sections
* fix changlog entry format
diff --git a/.mailmap b/.mailmap
@@ -0,0 +1,4 @@
+Christian Meißner <cme@codeaffen.org> <cme+github@meissner.sh>
+Christian Meißner <cme@codeaffen.org> <christian.meissner@unbelievable-machine.com>
+Andreas Klamke <andy@klamke.net> andreas.klamke <andreas.klamke@unbelievable-machine.com>
+Andreas Klamke <andy@klamke.net> <FlatKey@users.noreply.github.com>
diff --git a/changelogs/fragments/fix-tag-lookups.yml b/changelogs/fragments/fix-tag-lookups.yml
@@ -1,2 +1,2 @@
 bug_fixes:
-  - Fix tag lookups when specified in an `address` task (https://github.com/codeaffen/phpipam-ansible-modules/issues/57)
+  - Fix #57 - tag lookups failed when specified in an `address` task
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
@@ -0,0 +1 @@
+../CODE_OF_CONDUCT.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,9 @@ Welcome to phpIPAM Ansible Module documentation!
    :maxdepth: 2
    :caption: Developer documentation
 
+   Code of conduct <CODE_OF_CONDUCT>
    Contributing <CONTRIBUTING>
+   Releasing <release>
 
 Indices and tables
 ==================
diff --git a/docs/release.md b/docs/release.md
@@ -0,0 +1,13 @@
+# Releasing the collection
+
+To release the collection the following steps are required:
+
+* Create a pull request with the following changes:
+  * Updated `galaxy.yml`:
+    * Version bump
+    * Updated list of authors.
+
+      Generate that list via `git shortlog -e -s | sed -E 's/^\s+[[:digit:]]+\s+(.*)$/  - "\1"/'`.
+  * Updated changelog by running `antsibull-changelog release` -- it will pick up the version from `galaxy.yml`
+
+* After merging, tag the merge commit with `v<version number>` (i.e. v0.1.1).
diff --git a/galaxy.yml b/galaxy.yml
@@ -2,8 +2,12 @@ namespace: "codeaffen"
 name: "phpipam"
 description: Ansible Modules to manage phpIPAM installations
 authors:
-  - "Christian Meißner <cme+ansible@meissner.sh>"
-  - "Billy Longman <summacumwilly@github.com>"
+  - "Christian Meißner <cme@codeaffen.org>"
+  - "Andreas Klamke <andy@klamke.net>"
+  - "Billy Longman <bill.longman@summit-broadband.com>"
+  - "Mario Fritschen <github@fritschen.net>"
+  - "lush <porous@web.de>"
+  - "pyup-bot <github-bot@pyup.io>"
 version: "1.3.1"
 license:
   - "GPL-3.0-or-later"
diff --git a/plugins/modules/address.py b/plugins/modules/address.py
@@ -104,7 +104,7 @@
 
 EXAMPLES = '''
 - name: "Reserve an IP address"
-  codeaffen.phpipam.section:
+  codeaffen.phpipam.address:
     username: "admin"
     password: "s3cr3t"
     server_url: "https://ipam.example.com"
@@ -116,7 +116,7 @@
     state: present
 
 - name: "Remove address reservation"
-  codeaffen.phpipam.section:
+  codeaffen.phpipam.address:
     username: "admin"
     password: "s3cr3t"
     server_url: "https://ipam.example.com"

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +Christian Meißner <[email protected]> <[email protected]>
 +Christian Meißner <[email protected]> <[email protected]>
 +Andreas Klamke <[email protected]> andreas.klamke <[email protected]>
 +Andreas Klamke <[email protected]> <[email protected]>
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`bug_fixes:`
`2`		- - Fix tag lookups when specified in an `address` task (https://github.com/codeaffen/phpipam-ansible-modules/issues/57)
	`2`	+ - Fix #57 - tag lookups failed when specified in an `address` task