Fixes #24: Update CHANGELOG in preparation for release 0.1.0. (#26)

CHANGELOG.rst

@@ -1,5 +1,27 @@
-Will be updated by antsibull-changelog. Do not edit this manually!
+============================
+OKD Collection Release Notes
+============================
 
-See https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.rst for information on how to use antsibull-changelog.
+.. contents:: Topics
 
-Check out ``changelogs/config.yaml`` for its configuration. You need to change at least the ``title`` field in there.
+
+v0.1.0
+======
+
+Major Changes
+-------------
+
+- Add custom k8s module, integrate better Molecule tests (https://github.com/ansible-collections/community.okd/pull/7).
+- Add downstream build scripts to build redhat.openshift (https://github.com/ansible-collections/community.okd/pull/20).
+- Add openshift connection plugin, update inventory plugin to use it (https://github.com/ansible-collections/community.okd/pull/18).
+- Initial content migration from community.kubernetes (https://github.com/ansible-collections/community.okd/pull/3).
+
+Minor Changes
+-------------
+
+- Add incluster Makefile target for CI (https://github.com/ansible-collections/community.okd/pull/13).
+- Add tests for inventory plugin (https://github.com/ansible-collections/community.okd/pull/16).
+- CI Documentation for working with Prow (https://github.com/ansible-collections/community.okd/pull/15).
+- Docker container can run as an arbitrary user (https://github.com/ansible-collections/community.okd/pull/12).
+- Dockerfile now is properly set up to run tests in a rootless container (https://github.com/ansible-collections/community.okd/pull/11).
+- Integrate stale bot for issue queue maintenance (https://github.com/ansible-collections/community.okd/pull/14).

README.md

@@ -10,10 +10,14 @@ The collection includes a variety of Ansible content to help automate the manage
 
 Click on the name of a plugin or module to view that content's documentation:
 
-  - **Inventory Source**:
+  - **Connection Plugins**:
+    - [oc](https://docs.ansible.com/ansible/2.10/collections/community/general/oc_connection.html)
+  - **Inventory Plugins**:
     - [openshift](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/openshift_inventory.html)
   - **Modules**:
-    - [k8s](https://docs.ansible.com/ansible/latest/modules/k8s_module.html)
+    - [k8s](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_inventory.html)
+
+> **Note**: These documentation links currently link to older module versions. For the latest module documentation, please use `ansible-doc` in the CLI.
 
 ## Installation and Usage
 
@@ -91,23 +95,15 @@ where the `IMAGE_FORMAT` environment variable is the full reference to your cont
 
 ## Publishing New Versions
 
-The current process for publishing new versions of the OKD Collection is manual, and requires a user who has access to the `community.okd` namespace on Ansible Galaxy to publish the build artifact.
+Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
 
-  1. Ensure you're running Ansible from devel, so the [`build_ignore` key](https://github.com/ansible/ansible/issues/67130) in `galaxy.yml` is used.
+  1. Update `galaxy.yml` and this README's `requirements.yml` example with the new `version` for the collection.
-  1. Run `git clean -x -d -f` in this repository's directory to clean out any extra files which should not be included.
-  1. Update `galaxy.yml`, the `Makefile`, and this README's `requirements.yml` example with the new `version` for the collection.
   1. Update the CHANGELOG:
     1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
     1. Make sure there are fragments for all known changes in `changelogs/fragments`.
     1. Run `antsibull-changelog release`.
   1. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
   1. Tag the version in Git and push to GitHub.
-  1. Run the following commands to build and release the new version on Galaxy:
-
-     ```
-     ansible-galaxy collection build
-     ansible-galaxy collection publish ./community-okd-$VERSION_HERE.tar.gz
-     ```
 
 After the version is published, verify it exists on the [OKD Collection Galaxy page](https://galaxy.ansible.com/community/okd).
 

changelogs/changelog.yaml

@@ -1 +1,28 @@
-releases: {}
+ancestor: null
+releases:
+  0.1.0:
+    changes:
+      major_changes:
+      - Add custom k8s module, integrate better Molecule tests (https://github.com/ansible-collections/community.okd/pull/7).
+      - Add downstream build scripts to build redhat.openshift (https://github.com/ansible-collections/community.okd/pull/20).
+      - Add openshift connection plugin, update inventory plugin to use it (https://github.com/ansible-collections/community.okd/pull/18).
+      - Initial content migration from community.kubernetes (https://github.com/ansible-collections/community.okd/pull/3).
+      minor_changes:
+      - Add incluster Makefile target for CI (https://github.com/ansible-collections/community.okd/pull/13).
+      - Add tests for inventory plugin (https://github.com/ansible-collections/community.okd/pull/16).
+      - CI Documentation for working with Prow (https://github.com/ansible-collections/community.okd/pull/15).
+      - Docker container can run as an arbitrary user (https://github.com/ansible-collections/community.okd/pull/12).
+      - Dockerfile now is properly set up to run tests in a rootless container (https://github.com/ansible-collections/community.okd/pull/11).
+      - Integrate stale bot for issue queue maintenance (https://github.com/ansible-collections/community.okd/pull/14).
+    fragments:
+    - 1-initial-content.yml
+    - 11-dockerfile-tests.yml
+    - 12-dockerfile-tests.yml
+    - 13-makefile-tests.yml
+    - 15-ci-documentation.yml
+    - 16-inventory-plugin-tests.yml
+    - 18-openshift-connection-plugin.yml
+    - 20-downstream-build-scripts.yml
+    - 7-molecule-tests.yml
+    - 8-stale-bot.yml
+    release_date: '2020-09-04'

changelogs/fragments/1-initial-content.yml

@@ -0,0 +1,3 @@
+---
+major_changes:
+  - Initial content migration from community.kubernetes (https://github.com/ansible-collections/community.okd/pull/3).

changelogs/fragments/11-dockerfile-tests.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Dockerfile now is properly set up to run tests in a rootless container (https://github.com/ansible-collections/community.okd/pull/11).

changelogs/fragments/12-dockerfile-tests.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Docker container can run as an arbitrary user (https://github.com/ansible-collections/community.okd/pull/12).

changelogs/fragments/13-makefile-tests.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Add incluster Makefile target for CI (https://github.com/ansible-collections/community.okd/pull/13).

changelogs/fragments/15-ci-documentation.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - CI Documentation for working with Prow (https://github.com/ansible-collections/community.okd/pull/15).

changelogs/fragments/16-inventory-plugin-tests.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Add tests for inventory plugin (https://github.com/ansible-collections/community.okd/pull/16).

changelogs/fragments/18-openshift-connection-plugin.yml

@@ -0,0 +1,3 @@
+---
+major_changes:
+  - Add openshift connection plugin, update inventory plugin to use it (https://github.com/ansible-collections/community.okd/pull/18).

changelogs/fragments/20-downstream-build-scripts.yml

@@ -0,0 +1,3 @@
+---
+major_changes:
+  - Add downstream build scripts to build redhat.openshift (https://github.com/ansible-collections/community.okd/pull/20).

changelogs/fragments/7-molecule-tests.yml

@@ -0,0 +1,3 @@
+---
+major_changes:
+  - Add custom k8s module, integrate better Molecule tests (https://github.com/ansible-collections/community.okd/pull/7).

changelogs/fragments/8-stale-bot.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Integrate stale bot for issue queue maintenance (https://github.com/ansible-collections/community.okd/pull/14).