Skip to content

How to maintain this collection #406

@Andersson007

Description

@Andersson007
SUMMARY

This is an essence of the Collection Maintainer guidelines.

  • First of all, subscribe to this repo (the Watch button in the upper-right corner).

  • Review issues / pull requests:

    • Use the Collection Review Checklist.
    • If you're not a specialist in an area, review general stuff like doc correctness, for example.
    • Everything necessary is in place, for example, a changelog fragment.
    • No breaking changes are going to be introduced (at least unplanned, without proper preparations like announcements, deprecation, etc.).
    • Find and mention past contributors (look who contributed to a module/plugin including when the content lived in ansible/ansible.
    • Conduct pr-review days from time to time, i.e. to go through all open PRs asking folks if there are any obstacles, closing abandoned ones, etc.
  • Merge approved things (if any questions, ask on Matrix in the #community:ansible.im channel):

    • Backport them using the backport-* labels.
      • All things (except major_changes) from main to the current release branch (the latest stable-* branch).
      • Bugfixes to other supported branches.
  • Release (examine the Release guidelines:

    • When there's something to release. See changelog fragments / merged PRs in main since the last release in the current release branch - the highest stable-* branch.
    • Use the Release guidelines to conduct releases. There are step-by-step guides.
  • Look after CI:

    • Subscribe to the news-for-maintainers repo and keep things updated according to the announcements.
  • Try to find new maintainers for the whole collection, group of modules and individual modules. Always ask folks (after merging their PRs) for permission to add them in .github/BOTMETA.yml. As an example, see the comment.

  • It makes sense to take a look at the community-topics repo from time to time. There can be related topic, for example, Community collections: when to drop support for Ansible 2.9 and ansible-base 2.10? ansible-community/community-topics#50.

  • Regularly read the Collection Maintainer guidelines.

  • If you need advice, ask in on Matrix in the #community:ansible.im channel).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions