From e6d643421914085e8b7ccd0eed02826e4bbc1799 Mon Sep 17 00:00:00 2001 From: Marques Johansson Date: Mon, 19 Apr 2021 16:42:24 -0400 Subject: [PATCH 1/2] Include documentation about semver, releases, and changelog policies Signed-off-by: Marques Johansson --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d222088..0a20ec6 100644 --- a/README.md +++ b/README.md @@ -120,10 +120,20 @@ EOF ## Release notes +This project tags releases based on the Semantic Versioning specification. See for more details. Please pin your dependencies accordingly. + +Changes to this project can be reviewed in the [CHANGELOG.rst](https://github.com/equinix/ansible-collection-metal/blob/main/CHANGELOG.rst) file. + +It is possible to follow changes to the changelog by subscribing to , or "Watching" releases using the GitHub UI. + ## Roadmap +There is no predefined roadmap or timeline for new features or upcoming releases. + +New releases will be made as demands based on incoming issues or enhancements and the maintainers perceived need to distribute the resultant changes. + ## Publishing New Version Prepare the release: From 25d1f7a16ca022a076d036229b1043e076e1dba7 Mon Sep 17 00:00:00 2001 From: Marques Johansson Date: Fri, 23 Apr 2021 01:33:53 -0400 Subject: [PATCH 2/2] remove roadmap stub from README.md This block does not seem necessary, as it is not included in https://github.com/ansible-collections/ansible.windows or https://github.com/ansible-collections/ansible.aws Signed-off-by: Marques Johansson --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 0a20ec6..35c18b1 100644 --- a/README.md +++ b/README.md @@ -130,10 +130,6 @@ It is possible to follow changes to the changelog by subscribing to -There is no predefined roadmap or timeline for new features or upcoming releases. - -New releases will be made as demands based on incoming issues or enhancements and the maintainers perceived need to distribute the resultant changes. - ## Publishing New Version Prepare the release: