Module naming guidelines #881
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Docs Build 📝Thank you for contribution!✨ This PR has been merged and your docs changes will be incorporated when they are next published. |
tremble
force-pushed
the
docs/guidelines/naming
branch
from
a5f4a40
to
c9cc815
Compare
tremble
force-pushed
the
docs/guidelines/naming
branch
from
c9cc815
to
aad0a3b
Compare
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 04s |
jatorcasso
reviewed
Jun 23, 2022
jatorcasso
reviewed
Jun 23, 2022
jatorcasso
approved these changes
Jun 23, 2022
Co-authored-by: Joseph Torcasso <[email protected]>
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 23s |
jillr
approved these changes
Jun 23, 2022
markuman
approved these changes
Jun 24, 2022
|
Build succeeded (gate pipeline). ✔️ ansible-galaxy-importer SUCCESS in 4m 20s |
Backport to stable-4: 💚 backport PR created✅ Backport PR branch: Backported as #896 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Jun 24, 2022
Module naming guidelines SUMMARY Originally discussed in #610 Here's an initial attempt at some module naming (and module scoping) guidelines. Assuming we adopt this, I recommend is that: we can do the renames as part of 5.0.0, but this isn't a must and wouldn't be considered a blocker to 5.0.0 unless otherwise agreed. any modules moving from community.aws to amazon.aws would be renamed if appropriate as part of the move. we do not specify a deprecation date at this time, but leave a comment in the redirect that any deprecation cycle should not start before 2024-09-01 (to avoid potential migration fatigue issues), ISSUE TYPE Docs Pull Request COMPONENT NAME docs/docsite/rst/dev_guidelines.rst ADDITIONAL INFORMATION fixes: #610 Reviewed-by: Joseph Torcasso <None> Reviewed-by: Jill R <None> Reviewed-by: Markus Bergholz <[email protected]> (cherry picked from commit 289e987)
tremble
added a commit
that referenced
this pull request
Jun 24, 2022
Module naming guidelines SUMMARY Originally discussed in #610 Here's an initial attempt at some module naming (and module scoping) guidelines. Assuming we adopt this, I recommend is that: we can do the renames as part of 5.0.0, but this isn't a must and wouldn't be considered a blocker to 5.0.0 unless otherwise agreed. any modules moving from community.aws to amazon.aws would be renamed if appropriate as part of the move. we do not specify a deprecation date at this time, but leave a comment in the redirect that any deprecation cycle should not start before 2024-09-01 (to avoid potential migration fatigue issues), ISSUE TYPE Docs Pull Request COMPONENT NAME docs/docsite/rst/dev_guidelines.rst ADDITIONAL INFORMATION fixes: #610 Reviewed-by: Joseph Torcasso <None> Reviewed-by: Jill R <None> Reviewed-by: Markus Bergholz <[email protected]> (cherry picked from commit 289e987)
softwarefactory-project-zuul bot
pushed a commit
that referenced
this pull request
Jun 24, 2022
[PR #881/289e9870 backport][stable-4] Module naming guidelines This is a backport of PR #881 as merged into main (289e987). SUMMARY Originally discussed in #610 Here's an initial attempt at some module naming (and module scoping) guidelines. Assuming we adopt this, I recommend is that: we can do the renames as part of 5.0.0, but this isn't a must and wouldn't be considered a blocker to 5.0.0 unless otherwise agreed. any modules moving from community.aws to amazon.aws would be renamed if appropriate as part of the move. we do not specify a deprecation date at this time, but leave a comment in the redirect that any deprecation cycle should not start before 2024-09-01 (to avoid potential migration fatigue issues), ISSUE TYPE Docs Pull Request COMPONENT NAME docs/docsite/rst/dev_guidelines.rst ADDITIONAL INFORMATION fixes: #610 Reviewed-by: Mark Chappell <None>
This was referenced Jun 25, 2022
softwarefactory-project-zuul bot
pushed a commit
to ansible-collections/community.aws
that referenced
this pull request
Jun 25, 2022
Rename ACM modules SUMMARY In line with what I understood to be the consensus on ansible-collections/amazon.aws#881 and ansible-collections/amazon.aws#610 Rename aws_acm to acm_certificate Rename aws_acm_info to acm_certificate_info ISSUE TYPE Feature Pull Request COMPONENT NAME aws_acm aws_acm_info acm_certificate acm_certificate_info ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]>
jatorcasso
pushed a commit
to jatorcasso/amazon.aws
that referenced
this pull request
Jun 27, 2022
Module naming guidelines SUMMARY Originally discussed in ansible-collections#610 Here's an initial attempt at some module naming (and module scoping) guidelines. Assuming we adopt this, I recommend is that: we can do the renames as part of 5.0.0, but this isn't a must and wouldn't be considered a blocker to 5.0.0 unless otherwise agreed. any modules moving from community.aws to amazon.aws would be renamed if appropriate as part of the move. we do not specify a deprecation date at this time, but leave a comment in the redirect that any deprecation cycle should not start before 2024-09-01 (to avoid potential migration fatigue issues), ISSUE TYPE Docs Pull Request COMPONENT NAME docs/docsite/rst/dev_guidelines.rst ADDITIONAL INFORMATION fixes: ansible-collections#610 Reviewed-by: Joseph Torcasso <None> Reviewed-by: Jill R <None> Reviewed-by: Markus Bergholz <[email protected]>
softwarefactory-project-zuul bot
pushed a commit
to ansible-collections/community.aws
that referenced
this pull request
Jun 28, 2022
Rename SES modules SUMMARY In line with what I understood to be the consensus on ansible-collections/amazon.aws#881 and ansible-collections/amazon.aws#610 Rename ses modules to remove the aws_ prefix. ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_ses_identity.py plugins/modules/aws_ses_identity_policy.py plugins/modules/aws_ses_rule_set.py plugins/modules/ses_identity.py plugins/modules/ses_identity_policy.py plugins/modules/ses_rule_set.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None>
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Sep 18, 2023
…sible-collections#881) Fix cloudfront_distribution s3_origin_access_identity_enabled bug SUMMARY If s3_origin_access_identity_enabled is set to True but no s3_origin_config then a default origin config is applied however it also picks up s3_origin_access_identity_enabled as S3OriginAccessIdentityEnabled and passes it to the API request which is not a valid option to be passed and then fails validation. Fixes: ansible-collections#749 ISSUE TYPE Bugfix Pull Request COMPONENT NAME cloudfront_distribution ADDITIONAL INFORMATION The option mention is not valid for the API request: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudfront.html#CloudFront.Client.create_distribution Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis <None>
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Sep 18, 2023
Rename ACM modules SUMMARY In line with what I understood to be the consensus on ansible-collections#881 and ansible-collections#610 Rename aws_acm to acm_certificate Rename aws_acm_info to acm_certificate_info ISSUE TYPE Feature Pull Request COMPONENT NAME aws_acm aws_acm_info acm_certificate acm_certificate_info ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]>
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Sep 18, 2023
Rename SES modules SUMMARY In line with what I understood to be the consensus on ansible-collections#881 and ansible-collections#610 Rename ses modules to remove the aws_ prefix. ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_ses_identity.py plugins/modules/aws_ses_identity_policy.py plugins/modules/aws_ses_rule_set.py plugins/modules/ses_identity.py plugins/modules/ses_identity_policy.py plugins/modules/ses_rule_set.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None>
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Sep 18, 2023
…sible-collections#881) Fix cloudfront_distribution s3_origin_access_identity_enabled bug SUMMARY If s3_origin_access_identity_enabled is set to True but no s3_origin_config then a default origin config is applied however it also picks up s3_origin_access_identity_enabled as S3OriginAccessIdentityEnabled and passes it to the API request which is not a valid option to be passed and then fails validation. Fixes: ansible-collections#749 ISSUE TYPE Bugfix Pull Request COMPONENT NAME cloudfront_distribution ADDITIONAL INFORMATION The option mention is not valid for the API request: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudfront.html#CloudFront.Client.create_distribution Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis <None>
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Sep 18, 2023
Rename ACM modules SUMMARY In line with what I understood to be the consensus on ansible-collections#881 and ansible-collections#610 Rename aws_acm to acm_certificate Rename aws_acm_info to acm_certificate_info ISSUE TYPE Feature Pull Request COMPONENT NAME aws_acm aws_acm_info acm_certificate acm_certificate_info ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]>
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Sep 18, 2023
Rename SES modules SUMMARY In line with what I understood to be the consensus on ansible-collections#881 and ansible-collections#610 Rename ses modules to remove the aws_ prefix. ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_ses_identity.py plugins/modules/aws_ses_identity_policy.py plugins/modules/aws_ses_rule_set.py plugins/modules/ses_identity.py plugins/modules/ses_identity_policy.py plugins/modules/ses_rule_set.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None>
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Oct 24, 2023
…sible-collections#881) Fix cloudfront_distribution s3_origin_access_identity_enabled bug SUMMARY If s3_origin_access_identity_enabled is set to True but no s3_origin_config then a default origin config is applied however it also picks up s3_origin_access_identity_enabled as S3OriginAccessIdentityEnabled and passes it to the API request which is not a valid option to be passed and then fails validation. Fixes: ansible-collections#749 ISSUE TYPE Bugfix Pull Request COMPONENT NAME cloudfront_distribution ADDITIONAL INFORMATION The option mention is not valid for the API request: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudfront.html#CloudFront.Client.create_distribution Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis <None>
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Oct 26, 2023
Rename ACM modules SUMMARY In line with what I understood to be the consensus on ansible-collections#881 and ansible-collections#610 Rename aws_acm to acm_certificate Rename aws_acm_info to acm_certificate_info ISSUE TYPE Feature Pull Request COMPONENT NAME aws_acm aws_acm_info acm_certificate acm_certificate_info ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]> This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections/community.aws@ba08f90
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Oct 27, 2023
Rename ACM modules SUMMARY In line with what I understood to be the consensus on ansible-collections#881 and ansible-collections#610 Rename aws_acm to acm_certificate Rename aws_acm_info to acm_certificate_info ISSUE TYPE Feature Pull Request COMPONENT NAME aws_acm aws_acm_info acm_certificate acm_certificate_info ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]> This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections/community.aws@ba08f90
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Originally discussed in #610
Here's an initial attempt at some module naming (and module scoping) guidelines.
Assuming we adopt this, I recommend is that:
ISSUE TYPE
COMPONENT NAME
docs/docsite/rst/dev_guidelines.rst
ADDITIONAL INFORMATION
fixes: #610