Skip to content

Conversation

@richm
Copy link
Contributor

@richm richm commented Nov 14, 2025

community.general version 12 has dropped support for py27 and py36 - ensure that
the roles do not install/use this version - see
ansible-collections/community.general#582

By default, installation will get the latest 11.x version. The lower bound
6.6.0 is an older version, but I don't want to restrict the ability of a user
of a particular role to use an old version, rather than forcing them to use
11.x or later. Some roles like rhc explicitly require 6.6.0 or later - I
think this is a reasonable lower bound for all roles.If a role needs a different
version, the role can define its own community_general_version in the role's
host_vars file in .github.

Standardize file format across all roles for consistency and ease of updating

This update may remove the SPDX license information from the file - this is ok -
the role/project already has a license, this file is trivial, and many
requirements files do not have the license header anyway.

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Prevent community.general version 12 from being installed by default to retain Python 2.7 and 3.6 support and standardize requirement file formatting

Bug Fixes:

  • Lock community.general version default to >=6.6.0 and <12 to avoid dropping py27/py36 support

Enhancements:

  • Allow roles to override community_general_version in their host_vars
  • Standardize DO NOT EDIT header across all collection-requirements.yml files

Chores:

  • Remove SPDX license headers from trivial requirements files

community.general version 12 has dropped support for py27 and py36 - ensure that
the roles do not install/use this version - see
ansible-collections/community.general#582

By default, installation will get the latest 11.x version. The lower bound
`6.6.0` is an older version, but I don't want to restrict the ability of a user
of a particular role to use an old version, rather than forcing them to use
`11.x` or later. Some roles like `rhc` explicitly require `6.6.0` or later - I
think this is a reasonable lower bound for all roles.If a role needs a different
version, the role can define its own `community_general_version` in the role's
`host_vars` file in .github.

Standardize file format across all roles for consistency and ease of updating

This update may remove the SPDX license information from the file - this is ok -
the role/project already has a license, this file is trivial, and many
requirements files do not have the license header anyway.

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm self-assigned this Nov 14, 2025
@richm richm requested a review from spetrosi as a code owner November 14, 2025 20:10
@sourcery-ai
Copy link

sourcery-ai bot commented Nov 14, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR prevents installation of community.general v12 (which dropped py27/py36 support) by constraining versions to a lower bound of 6.6.0 and capping at 11.x (with per-role overrides), and it standardizes the format of collection-requirements files across all roles (including removing redundant SPDX headers).

Entity relationship diagram for updated collection requirements constraints

erDiagram
    ROLE {
        string name
        string community_general_version
    }
    COLLECTION_REQUIREMENTS {
        string file_format
        string community_general_version_constraint
    }
    ROLE ||--|{ COLLECTION_REQUIREMENTS : defines
    COLLECTION_REQUIREMENTS }|--|{ COMMUNITY_GENERAL : includes
    COMMUNITY_GENERAL {
        string version
        string python_support
    }
    COMMUNITY_GENERAL }|--|{ PYTHON_VERSION : supports
    PYTHON_VERSION {
        string version
    }
Loading

Class diagram for collection requirements version constraint logic

classDiagram
    class Role {
        +string name
        +string community_general_version
        +overrideCommunityGeneralVersion()
    }
    class CollectionRequirements {
        +string file_format
        +string community_general_version_constraint
        +standardizeFormat()
    }
    class CommunityGeneral {
        +string version
        +string python_support
    }
    class PythonVersions {
        +PY27
        +PY36
    }
    Role --> CollectionRequirements : defines
    CollectionRequirements --> CommunityGeneral : includes
    CommunityGeneral --> PythonVersions : dropped in v12
Loading

File-Level Changes

Change Details Files
Enforce community.general version constraints to avoid v12
  • Set default version range to '>=6.6.0,<12.0.0', which yields the latest 11.x release by default
  • Allow per-role override via the community_general_version variable in host_vars
meta/collection-requirements.yml
roles/*/meta/collection-requirements.yml
Standardize format of collection-requirements files
  • Add a top-line management comment ('DO NOT EDIT...')
  • Ensure consistent YAML delimiters and indentation across all requirement files
  • Remove redundant SPDX license headers from trivial requirements files
meta/collection-requirements.yml
roles/*/meta/collection-requirements.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@richm richm merged commit 02e7d8c into main Nov 15, 2025
31 checks passed
@richm richm deleted the community-general-11.x branch November 15, 2025 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants