Deprecate collection and its contents (#10)

* Deprecate collection and its contents.

* Added why.

* Explicitly give version.

* Add ignore file for 2.9.

Author: felixfontein

README.md

@@ -2,7 +2,7 @@
 [![CI](https://github.com/felixfontein/ansible-hosttech_dns/workflows/CI/badge.svg?event=push&branch=main)](https://github.com/felixfontein/ansible-hosttech_dns/actions?query=workflow%3A%22CI%22+branch%3Amain)
 [![Codecov](https://img.shields.io/codecov/c/github/felixfontein/ansible-hosttech_dns)](https://codecov.io/gh/felixfontein/ansible-hosttech_dns)
 
-**Please consider using the [`community.dns`](https://galaxy.ansible.com/community/dns) collection and its HostTech DNS modules instead!**
+**This collection and its contents are depreated! Please use the [`community.dns`](https://galaxy.ansible.com/community/dns) collection and its HostTech DNS modules instead!**
 
 This repository provides an [Ansible](https://github.com/ansible/ansible) collection with modules to create, modify and delete DNS records for zones hosted at the Swiss provider [Hosttech](https://www.hosttech.ch/) using their [API](https://ns1.hosttech.eu/public/api?wsdl).
 

changelogs/fragments/1.2.0.yml

@@ -0,0 +1,4 @@
+release_summary: Deprecation release.
+deprecated_features:
+  - This collection is deprecated. Please use `community.dns <https://galaxy.ansible.com/community/dns>`_, which is also included
+    in Ansible 4+. It contains improved versions of the modules of this collection and receives updates.

meta/runtime.yml

@@ -1,2 +1,12 @@
 ---
 requires_ansible: '>=2.9.10'
+plugin_routing:
+  modules:
+    hosttech_dns_record:
+      deprecation:
+        warning_text: The felixfontein.hosttech_dns.hosttech_dns_record is deprecated. Use community.dns.hetzner_dns_record_set instead.
+        removal_version: 2.0.0
+    hosttech_dns_record_info:
+      deprecation:
+        warning_text: The felixfontein.hosttech_dns.hosttech_dns_record_info is deprecated. Use community.dns.hetzner_dns_record_set_info instead.
+        removal_version: 2.0.0

plugins/modules/hosttech_dns_record.py

@@ -16,6 +16,11 @@
 
 version_added: 1.0.0
 
+deprecated:
+    why: This collection is no longer updated.
+    alternative: Use community.dns.hetzner_dns_record_set instead.
+    removed_in: 2.0.0
+
 description:
     - "Creates and deletes DNS records in Hosttech DNS service U(https://ns1.hosttech.eu/public/api?wsdl)."
 

plugins/modules/hosttech_dns_record_info.py

@@ -16,6 +16,11 @@
 
 version_added: 1.0.0
 
+deprecated:
+    why: This collection is no longer updated.
+    alternative: Use community.dns.hetzner_dns_record_set_info instead.
+    removed_in: 2.0.0
+
 description:
     - "Retrieves DNS records in Hosttech DNS service U(https://ns1.hosttech.eu/public/api?wsdl)."
 

tests/sanity/ignore-2.9.txt

@@ -0,0 +1,6 @@
+plugins/modules/hosttech_dns_record.py validate-modules:deprecation-mismatch
+plugins/modules/hosttech_dns_record.py validate-modules:invalid-documentation
+plugins/modules/hosttech_dns_record.py validate-modules:missing-main-call
+plugins/modules/hosttech_dns_record_info.py validate-modules:deprecation-mismatch
+plugins/modules/hosttech_dns_record_info.py validate-modules:invalid-documentation
+plugins/modules/hosttech_dns_record_info.py validate-modules:missing-main-call