Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Module naming guidelines #881

Merged
merged 2 commits into from
Jun 24, 2022
Merged

Module naming guidelines #881

merged 2 commits into from
Jun 24, 2022

Conversation

tremble
Copy link
Contributor

@tremble tremble commented Jun 21, 2022

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

@tremble tremble mentioned this pull request Jun 21, 2022
Closed
@github-actions
Copy link

github-actions bot commented Jun 21, 2022 •
edited
Loading

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 4m 04s
✔️ build-ansible-collection SUCCESS in 5m 02s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 9m 29s
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 9m 25s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 9m 35s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 28s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 6m 41s

jatorcasso
jatorcasso approved these changes Jun 23, 2022
View reviewed changes
Copy link
Contributor

@jatorcasso jatorcasso left a comment

Choose a reason for hiding this comment

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

Content wise this LGTM. Of course we should wait for others but everything here seems clear to me

@tremble @jatorcasso
Apply suggestions from code review
72828c1 
Co-authored-by: Joseph Torcasso <87090265+jatorcasso@users.noreply.github.com>
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 4m 23s
✔️ build-ansible-collection SUCCESS in 4m 50s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 10m 03s
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 8m 46s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 9m 26s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 07s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 6m 22s

@tremble tremble added the mergeit Merge the PR (SoftwareFactory) label Jun 24, 2022
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded (gate pipeline).

✔️ ansible-galaxy-importer SUCCESS in 4m 20s
✔️ build-ansible-collection SUCCESS in 4m 56s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 9m 33s
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 9m 55s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 10m 19s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 5m 24s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 6m 01s

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit 289e987 into ansible-collections:main Jun 24, 2022
@tremble tremble added the backport-4 PR should be backported to the stable-4 branch label Jun 24, 2022
@patchback
Copy link

patchback bot commented Jun 24, 2022 •
edited
Loading

Backport to stable-4: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-4/289e98702ef8258935167d5017b3ac040d93f30b/pr-881

Backported as #896

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jun 24, 2022
@tremble @patchback
Module naming guidelines (#881)
d5e3fec 
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 <git@osuv.de>
(cherry picked from commit 289e987)
@patchback patchback bot mentioned this pull request Jun 24, 2022
Merged
tremble added a commit that referenced this pull request Jun 24, 2022
@tremble
Module naming guidelines (#881)
785384b 
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 <git@osuv.de>
(cherry picked from commit 289e987)
softwarefactory-project-zuul bot pushed a commit that referenced this pull request Jun 24, 2022
@patchback
Module naming guidelines (#881) (#896)
43e2c3e 
[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
Merged
Merged
softwarefactory-project-zuul bot pushed a commit to ansible-collections/community.aws that referenced this pull request Jun 25, 2022
@tremble
Rename ACM modules (#1263)
ba08f90 
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 <git@osuv.de>
jatorcasso pushed a commit to jatorcasso/amazon.aws that referenced this pull request Jun 27, 2022
@tremble @jatorcasso
Module naming guidelines (ansible-collections#881)
f2a1cdb 
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 <git@osuv.de>
softwarefactory-project-zuul bot pushed a commit to ansible-collections/community.aws that referenced this pull request Jun 28, 2022
@tremble
Rename ses modules (#1264)
2183ffa 
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>
@tremble tremble deleted the docs/guidelines/naming branch September 9, 2022 08:51
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Sep 18, 2023
@marknet15
Fix cloudfront_distribution s3_origin_access_identity_enabled bug (an…
ae12658 
…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 <git@osuv.de>
Reviewed-by: Alina Buzachis <None>
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Sep 18, 2023
@tremble
Rename ACM modules (ansible-collections#1263)
5fa3195 
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 <git@osuv.de>
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Sep 18, 2023
@tremble
Rename ses modules (ansible-collections#1264)
9ec4ac7 
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
@marknet15 @abikouo
Fix cloudfront_distribution s3_origin_access_identity_enabled bug (an…
7247b4a 
…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 <git@osuv.de>
Reviewed-by: Alina Buzachis <None>
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Sep 18, 2023
@tremble @abikouo
Rename ACM modules (ansible-collections#1263)
d44c54d 
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 <git@osuv.de>
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Sep 18, 2023
@tremble @abikouo
Rename ses modules (ansible-collections#1264)
9a4f1a6 
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
@marknet15
Fix cloudfront_distribution s3_origin_access_identity_enabled bug (an…
cecc9e8 
…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 <git@osuv.de>
Reviewed-by: Alina Buzachis <None>
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Oct 26, 2023
@tremble @abikouo
Rename ACM modules (ansible-collections#1263)
03d14b5 
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 <git@osuv.de>

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
@tremble @github-actions
Rename ACM modules (ansible-collections#1263)
47d3ff7 
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 <git@osuv.de>

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
Reviewers

@jatorcasso jatorcasso jatorcasso approved these changes

@jillr jillr jillr approved these changes

@markuman markuman markuman approved these changes

@alinabuzachis alinabuzachis Awaiting requested review from alinabuzachis

Assignees
No one assigned
Labels
backport-4 PR should be backported to the stable-4 branch community_review docs has_issue mergeit Merge the PR (SoftwareFactory) needs_triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Define a naming scheme for AWS modules
5 participants
@tremble @markuman @jillr @jatorcasso @ansibullbot