Skip to content
This repository has been archived by the owner on Sep 10, 2024. It is now read-only.

Include documentation about semver, releases, and changelog policies #31

Merged
merged 2 commits into from
Oct 10, 2023
Merged

Include documentation about semver, releases, and changelog policies #31

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6d6434
Include documentation about semver, releases, and changelog policies
displague Apr 19, 2021
25d1f7a
remove roadmap stub from README.md
displague Apr 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,20 @@ EOF
## Release notes
<!--Add a link to a changelog.rst file or an external docsite to cover this information. -->

This project tags releases based on the Semantic Versioning specification. See <https://semver.org/#semantic-versioning-specification-semver> 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 <https://github.com/equinix/ansible-collection-metal/releases.atom>, or "Watching" releases using the GitHub UI.

## Roadmap

<!-- Optional. Include the roadmap for this collection, and the proposed release/versioning strategy so users can anticipate the upgrade/update cycle. -->

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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence reads a little strange to me..

Copy link
Member Author

@displague displague Apr 22, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it would be best to defer to https://github.com/packethost/standards/blob/main/maintained-statement.md. (Edit: This doesn't really add anything relevant 🙁 )

I'd like to say something of our process and roadmap'ing here, but I have nothing specific to offer at the moment (that I can stand behind).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left the roadmap section empty - it isn't used by https://github.com/ansible-collections/ansible.windows or https://github.com/ansible-collections/ansible.aws


## Publishing New Version

Prepare the release:
Expand Down