diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 297a040..7f8fe6f 100644 --- a/CHANGELOG.rst +++ b/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). diff --git a/README.md b/README.md index 1c09959..7ef8e0d 100644 --- a/README.md +++ b/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 @@ -56,7 +60,7 @@ For documentation on how to use individual plugins included in this collection, If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there. -The `tests` directory contains configuration for running sanity tests using [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html). +The `tests` directory contains configuration for running sanity tests using [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html). You can run the `ansible-test` sanity tests with the command: @@ -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. 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 `galaxy.yml` 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). diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 2abdaca..450d17f 100644 --- a/changelogs/changelog.yaml +++ b/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' diff --git a/changelogs/fragments/1-initial-content.yml b/changelogs/fragments/1-initial-content.yml new file mode 100644 index 0000000..5343685 --- /dev/null +++ b/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). diff --git a/changelogs/fragments/11-dockerfile-tests.yml b/changelogs/fragments/11-dockerfile-tests.yml new file mode 100644 index 0000000..c7107c9 --- /dev/null +++ b/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). diff --git a/changelogs/fragments/12-dockerfile-tests.yml b/changelogs/fragments/12-dockerfile-tests.yml new file mode 100644 index 0000000..4dff8df --- /dev/null +++ b/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). diff --git a/changelogs/fragments/13-makefile-tests.yml b/changelogs/fragments/13-makefile-tests.yml new file mode 100644 index 0000000..2333531 --- /dev/null +++ b/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). diff --git a/changelogs/fragments/15-ci-documentation.yml b/changelogs/fragments/15-ci-documentation.yml new file mode 100644 index 0000000..6e9c46f --- /dev/null +++ b/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). diff --git a/changelogs/fragments/16-inventory-plugin-tests.yml b/changelogs/fragments/16-inventory-plugin-tests.yml new file mode 100644 index 0000000..ed0f828 --- /dev/null +++ b/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). diff --git a/changelogs/fragments/18-openshift-connection-plugin.yml b/changelogs/fragments/18-openshift-connection-plugin.yml new file mode 100644 index 0000000..010dfb0 --- /dev/null +++ b/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). diff --git a/changelogs/fragments/20-downstream-build-scripts.yml b/changelogs/fragments/20-downstream-build-scripts.yml new file mode 100644 index 0000000..64007b7 --- /dev/null +++ b/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). diff --git a/changelogs/fragments/7-molecule-tests.yml b/changelogs/fragments/7-molecule-tests.yml new file mode 100644 index 0000000..3f884c6 --- /dev/null +++ b/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). diff --git a/changelogs/fragments/8-stale-bot.yml b/changelogs/fragments/8-stale-bot.yml new file mode 100644 index 0000000..c20ae11 --- /dev/null +++ b/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).