Notes for contributors and maintainers

[NomakCooper]

Summary

ans2dev.general v0.1.0

Notes for contributors and maintainers

This issue contains notes for contributors and maintainers.

Basic rules:

• Direct commits to this repository are not allowed. All operations must be performed using a fork, followed by opening a cross-fork pull request (PR).

• Issues and PRs use an automatic labeling system, so there is no need to manually assign generic labels.

• Every PR is subject to ansible-test Sanity, Units, and Integration tests via CI with GitHub Actions. In case of failure, 3A2BOT should add a comment with the detected errors.

• Every PR must be approved before it can be merged. Approval can be given by commenting with the /approve command, after which repo-command[bot] will handle the approval.

• Before merging, the label backport-10 must be manually added so that upon merge, patchback[bot] can automatically open the backport PR toward the stable-10 branch.

• The merge must always be performed using squash and merge.

Basic Contribution rules:

• Every type of contribution must be tested and accompanied by documentation.

• In the case of new modules or plugins, it is also necessary to create the corresponding unit and integration test files.

• Every change, except for new modules or plugins, must be accompanied by a file in changelogs/fragments following the Ansible community convention.

Basic Collection Maintainers rules:

• Before performing a new release and publishing the collection on Ansible Galaxy, it is necessary to ensure that the galaxy.yml file contains the updated version number.

• Prior to publishing, the new changelog version must be released.
  You can check the syntax of the fragment files using the command:

  antsibull-changelog lint

  Then, you can release the new changelog version using the command:

  antsibull-changelog release --version <version number>

• Once the new changelog is generated, you can open a pre-release PR and, for convenience, also add the pre_publish label.

• If everything is ready, you can proceed with publishing the new version using the GitHub Action: Release and Publish Ansible Collection.

• After publishing the new version, it is necessary to open a post-release PR (for convenience, we manually add the post_publish label), updating the future version in the galaxy.yml file and creating the new file changelogs/fragments/<new version>.yml.

• In the file, simply include the following text:

  release_summary: |
    New release of the ``ans2dev.general`` collection.
    The changelog describes all changes made to the modules and plugins included in this collection.

Issue Type

Documentation Report

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[NomakCooper]

Last Release

• Actual version 0.1.0
• Next Version 0.2.0

---

• galaxy.yml file updated with next version
• release_summary file ready for next version