Inclusion of mellanox.onyx in Ansible 2.10

felixfontein commented 4 years ago

This collection will be included in Ansible 2.10 because it contains modules and/or plugins that were included in Ansible 2.9. Please review:

The list of requirements for inclusion in Ansible: https://github.com/ansible-collections/overview/blob/master/collection_requirements.rst
The roadmap with all important dates for Ansible 2.10: https://github.com/ansible/ansible/blob/devel/docs/docsite/rst/roadmap/COLLECTIONS_2_10.rst

DEADLINE: 2020-08-18

The latest version of the collection available on August 18 will be included in Ansible 2.10.0, except possibly newer versions which differ only in the patch level. (For details, see the roadmap). Please release version 1.0.0 of your collection by this date! If 1.0.0 does not exist, the same 0.x.y version will be used in all of Ansible 2.10 without updates, and your 1.x.y release will not be included until Ansible 2.11 (unless you request an exception at a community working group meeting and go through a demanding manual process to vouch for backwards compatibility . . . you want to avoid this!).

Follow semantic versioning rules

Your collection versioning must follow all semver rules. This means:

Patch level releases can only contain bugfixes;
Minor releases can contain new features, new modules and plugins, and bugfixes, but must not break backwards compatibility;
Major releases can break backwards compatibility.

Changelogs and Porting Guide

Your collection should provide data for the Ansible 2.10 changelog and porting guide. The changelog and porting guide are automatically generated from ansible-base, and from the changelogs of the included collections. All changes from the breaking_changes, major_changes, removed_features and deprecated_features sections will appear in both the changelog and the porting guide. You have two options for providing changelog fragments to include:

If possible, use the antsibull-changelog tool, which uses the same changelog fragment as the ansible/ansible repository (see the documentation).
If you cannot use antsibull-changelog, you can provide the changelog in a machine-readable format as changelogs/changelog.yaml inside your collection (see the documentation of changelogs/changelog.yaml format).

If you cannot contribute to the integrated Ansible changelog using one of these methods, please provide a link to your collection's changelog by creating an issue in https://github.com/ansible-community/ansible-build-data/. If you do not provide changelogs/changelog.yml or a link, users will not be able to find out what changed in your collection from the Ansible changelog and porting guide.

Make sure your collection passes the sanity tests

Run ansible-test sanity --docker -v in the collection with the latest ansible-base or stable-2.10 ansible/ansible checkout.

Keep informed

Be sure you're subscribed to:

Changes impacting Collections to track changes that Collection maintainers should be aware of;
The Bullhorn, a newsletter for the Ansible developer community, back issues and how to add content.

Questions and Feedback

If you have questions or want to provide feedback, please see the Feedback section in the collection requirements.

(Internal link to keep track of issues: ansible-collections/overview#102)

felixfontein commented 4 years ago

Please note that the deadline for releasing 1.0.0 is tomorrow!

CC @samerd

samerd commented 4 years ago

Thanks @felixfontein In fact, I do not have any changes since 0.1.0. Is there a need to create a new version with no changes?

felixfontein commented 4 years ago

@samerd two things:

you could add a changelog. Changelogs are really useful for users, since they can see what changed between versions.
if you publish updates (bugfixes, new features) of the collection, these will get automatically picked up for Ansible 2.10.x releases. If you have only 0.x.y released by tomorrow, that version will be used for all Ansible 2.10.x releases (except if you manually intervene and try to convince the community meeting that you didn't break backwards compatibility with a new release).

felixfontein commented 4 years ago

(Also, 0.x.y releases are by definition not stable.)

samerd commented 4 years ago

thanks. will try to release 1.0.0

samerd commented 4 years ago

release 1.0.0 has been published https://galaxy.ansible.com/mellanox/onyx

felixfontein commented 2 years ago

Closing since Ansible 2.10 has long been released. (Ansible 5 is coming up next.)

ansible-collections / mellanox.onyx