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.

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

Update return block of ec2 modules (part 2) #2079

Conversation

GomathiselviS
Copy link
Collaborator

SUMMARY

Refer #1983

This PR aligns the RETURN blocks in the module documentation to accurately reflect what the module returns, ensuring consistency.

Modules updated:

ec2_snapshot ec2_snapshot_info ec2_spot_instance ec2_vol ec2_vpc_endpoint ec2_vpc_endpoint_info ec2_vpc_endpoint_service_info ec2_vpc_nat_gateway ec2_vpc_nat_gateway_info ec2_vpc_route_table ec2_vpc_subnet ec2_vpc_subnet_info

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

Copy link

github-actions bot commented May 8, 2024

Docs Build 📝

Thank you for contribution!✨

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

Copy link
Contributor

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/16c92c27d1e94e61ada3f6c9ba9dea74

ansible-galaxy-importer FAILURE in 5m 23s
✔️ build-ansible-collection SUCCESS in 17m 11s
✔️ ansible-test-splitter SUCCESS in 8m 00s
✔️ integration-amazon.aws-1 SUCCESS in 16m 05s
✔️ integration-amazon.aws-2 SUCCESS in 33m 01s
✔️ integration-amazon.aws-3 SUCCESS in 13m 15s
✔️ integration-amazon.aws-4 SUCCESS in 20m 28s
✔️ integration-amazon.aws-5 SUCCESS in 10m 02s
✔️ integration-amazon.aws-6 SUCCESS in 11m 34s
✔️ integration-amazon.aws-7 SUCCESS in 6m 56s
✔️ integration-amazon.aws-8 SUCCESS in 6m 32s
Skipped 36 jobs

Copy link
Contributor

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/fd7478b0dd554dfd8d5b6f4044c159a8

ansible-galaxy-importer FAILURE in 4m 31s
✔️ build-ansible-collection SUCCESS in 15m 46s
✔️ ansible-test-splitter SUCCESS in 8m 07s
✔️ integration-amazon.aws-1 SUCCESS in 17m 27s
✔️ integration-amazon.aws-2 SUCCESS in 18m 55s
✔️ integration-amazon.aws-3 SUCCESS in 16m 59s
✔️ integration-amazon.aws-4 SUCCESS in 23m 59s
✔️ integration-amazon.aws-5 SUCCESS in 12m 58s
✔️ integration-amazon.aws-6 SUCCESS in 15m 08s
✔️ integration-amazon.aws-7 SUCCESS in 10m 24s
✔️ integration-amazon.aws-8 SUCCESS in 9m 46s
Skipped 36 jobs

Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/ce3b9886a53345adae6362f03a971b98

✔️ ansible-galaxy-importer SUCCESS in 4m 47s
✔️ build-ansible-collection SUCCESS in 15m 20s
✔️ ansible-test-splitter SUCCESS in 6m 14s
✔️ integration-amazon.aws-1 SUCCESS in 15m 40s
✔️ integration-amazon.aws-2 SUCCESS in 17m 37s
✔️ integration-amazon.aws-3 SUCCESS in 12m 36s
✔️ integration-amazon.aws-4 SUCCESS in 21m 12s
✔️ integration-amazon.aws-5 SUCCESS in 8m 34s
✔️ integration-amazon.aws-6 SUCCESS in 11m 08s
✔️ integration-amazon.aws-7 SUCCESS in 7m 03s
✔️ integration-amazon.aws-8 SUCCESS in 6m 26s
✔️ integration-community.aws-1 SUCCESS in 16m 30s
✔️ integration-community.aws-2 SUCCESS in 7m 25s
Skipped 34 jobs

@@ -138,6 +138,11 @@
returned: I(state=present)
type: str
sample: us-east-1a
availability_zone_id:
description: The AZ ID of the subnet.
returned: I(state=present)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
returned: I(state=present)
returned: O(state=present)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Could you please share the reason behind this suggestion?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

describes here in the section Semantic markup within module documentation

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Agreed! I am curious if there is a guideline that prioritizes semantic markup over macros. However, I think it would be advantageous to incorporate this as a guideline in the cloud content coding standards document.

plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vol.py Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Show resolved Hide resolved
Copy link
Contributor

@abikouo abikouo left a comment

Choose a reason for hiding this comment

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

LGTM
Just some minor remark to address

Copy link
Contributor

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/ecf7c99983ef4170b3992e9c202ca74b

✔️ ansible-galaxy-importer SUCCESS in 5m 59s
✔️ build-ansible-collection SUCCESS in 15m 16s
✔️ ansible-test-splitter SUCCESS in 6m 42s
✔️ integration-amazon.aws-1 SUCCESS in 13m 30s
✔️ integration-amazon.aws-2 SUCCESS in 19m 01s
✔️ integration-amazon.aws-3 SUCCESS in 12m 36s
✔️ integration-amazon.aws-4 SUCCESS in 20m 42s
✔️ integration-amazon.aws-5 SUCCESS in 14m 14s
✔️ integration-amazon.aws-6 SUCCESS in 10m 16s
✔️ integration-amazon.aws-7 SUCCESS in 6m 11s
integration-amazon.aws-8 FAILURE in 14m 53s
✔️ integration-amazon.aws-9 SUCCESS in 6m 22s
Skipped 35 jobs

Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/61ec4d521b5a49a0a4186b207926e63f

✔️ ansible-galaxy-importer SUCCESS in 4m 42s
✔️ build-ansible-collection SUCCESS in 16m 46s
✔️ ansible-test-splitter SUCCESS in 7m 30s
✔️ integration-amazon.aws-1 SUCCESS in 16m 24s
✔️ integration-amazon.aws-2 SUCCESS in 22m 42s
✔️ integration-amazon.aws-3 SUCCESS in 17m 38s
✔️ integration-amazon.aws-4 SUCCESS in 26m 35s
✔️ integration-amazon.aws-5 SUCCESS in 9m 45s
✔️ integration-amazon.aws-6 SUCCESS in 10m 47s
✔️ integration-amazon.aws-7 SUCCESS in 7m 07s
✔️ integration-amazon.aws-8 SUCCESS in 6m 30s
✔️ integration-amazon.aws-9 SUCCESS in 9m 36s
Skipped 35 jobs

plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_vpc_subnet_info.py Outdated Show resolved Hide resolved
Copy link
Contributor

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/2cac9ac1520f435f99e769f3ceb16904

✔️ ansible-galaxy-importer SUCCESS in 5m 58s
✔️ build-ansible-collection SUCCESS in 17m 03s
✔️ ansible-test-splitter SUCCESS in 6m 56s
✔️ integration-amazon.aws-1 SUCCESS in 18m 29s
✔️ integration-amazon.aws-2 SUCCESS in 20m 10s
✔️ integration-amazon.aws-3 SUCCESS in 16m 22s
✔️ integration-amazon.aws-4 SUCCESS in 23m 33s
✔️ integration-amazon.aws-5 SUCCESS in 12m 42s
integration-amazon.aws-6 RETRY_LIMIT in 1m 43s
✔️ integration-amazon.aws-7 SUCCESS in 10m 38s
✔️ integration-amazon.aws-8 SUCCESS in 7m 11s
✔️ integration-amazon.aws-9 SUCCESS in 8m 41s
Skipped 35 jobs

Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/76c9c9bb3cbf4ad2bc61c486fa09c992

✔️ ansible-galaxy-importer SUCCESS in 7m 12s
✔️ build-ansible-collection SUCCESS in 14m 54s
✔️ ansible-test-splitter SUCCESS in 5m 53s
✔️ integration-amazon.aws-1 SUCCESS in 19m 02s
✔️ integration-amazon.aws-2 SUCCESS in 24m 51s
✔️ integration-amazon.aws-3 SUCCESS in 14m 51s
✔️ integration-amazon.aws-4 SUCCESS in 25m 56s
✔️ integration-amazon.aws-5 SUCCESS in 11m 21s
✔️ integration-amazon.aws-6 SUCCESS in 14m 20s
✔️ integration-amazon.aws-7 SUCCESS in 8m 27s
✔️ integration-amazon.aws-8 SUCCESS in 7m 08s
✔️ integration-amazon.aws-9 SUCCESS in 13m 07s
Skipped 35 jobs

Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/3acecf6ce66b4d8d93ac7ae52fb782b4

✔️ ansible-galaxy-importer SUCCESS in 5m 37s
✔️ build-ansible-collection SUCCESS in 15m 08s
✔️ ansible-test-splitter SUCCESS in 7m 12s
✔️ integration-amazon.aws-1 SUCCESS in 17m 50s
✔️ integration-amazon.aws-2 SUCCESS in 19m 03s
✔️ integration-amazon.aws-3 SUCCESS in 12m 54s
✔️ integration-amazon.aws-4 SUCCESS in 20m 33s
✔️ integration-amazon.aws-5 SUCCESS in 13m 05s
✔️ integration-amazon.aws-6 SUCCESS in 14m 49s
✔️ integration-amazon.aws-7 SUCCESS in 10m 00s
✔️ integration-amazon.aws-8 SUCCESS in 10m 01s
✔️ integration-amazon.aws-9 SUCCESS in 9m 53s
Skipped 35 jobs

@GomathiselviS GomathiselviS added the mergeit Merge the PR (SoftwareFactory) label May 21, 2024
Copy link
Contributor

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/8d374d87210849afb62ca5bea0e47e6f

✔️ ansible-galaxy-importer SUCCESS in 5m 12s
✔️ build-ansible-collection SUCCESS in 14m 27s
✔️ ansible-test-splitter SUCCESS in 5m 57s
✔️ integration-amazon.aws-1 SUCCESS in 16m 34s
✔️ integration-amazon.aws-2 SUCCESS in 18m 00s
✔️ integration-amazon.aws-3 SUCCESS in 14m 29s
✔️ integration-amazon.aws-4 SUCCESS in 20m 37s
✔️ integration-amazon.aws-5 SUCCESS in 9m 34s
✔️ integration-amazon.aws-6 SUCCESS in 14m 34s
✔️ integration-amazon.aws-7 SUCCESS in 7m 06s
✔️ integration-amazon.aws-8 SUCCESS in 7m 38s
✔️ integration-amazon.aws-9 SUCCESS in 7m 33s
Skipped 35 jobs

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit 9429894 into ansible-collections:main May 21, 2024
35 of 36 checks passed
@tremble tremble added the backport-8 PR should be backported to the stable-8 branch label Aug 27, 2024
Copy link

patchback bot commented Aug 27, 2024

Backport to stable-8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-8/94298948feae128f77eb19ecb190a2109e47c926/pr-2079

Backported as #2244

🤖 @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 Aug 27, 2024
Update return block of ec2 modules (part 2)

SUMMARY

Refer #1983
This PR aligns the RETURN blocks in the module documentation to accurately reflect what the module returns, ensuring consistency.
Modules updated:
ec2_snapshot ec2_snapshot_info ec2_spot_instance ec2_vol ec2_vpc_endpoint ec2_vpc_endpoint_info ec2_vpc_endpoint_service_info ec2_vpc_nat_gateway ec2_vpc_nat_gateway_info ec2_vpc_route_table ec2_vpc_subnet ec2_vpc_subnet_info
ISSUE TYPE

Docs Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis
Reviewed-by: GomathiselviS
Reviewed-by: Bikouo Aubin
Reviewed-by: Mike Graves <[email protected]>
(cherry picked from commit 9429894)
softwarefactory-project-zuul bot pushed a commit that referenced this pull request Aug 27, 2024
This is a backport of PR #2079 as merged into main (9429894).
SUMMARY


Refer #1983
This PR aligns the RETURN blocks in the module documentation to accurately reflect what the module returns, ensuring consistency.
Modules updated:
ec2_snapshot ec2_snapshot_info ec2_spot_instance ec2_vol ec2_vpc_endpoint ec2_vpc_endpoint_info ec2_vpc_endpoint_service_info ec2_vpc_nat_gateway ec2_vpc_nat_gateway_info ec2_vpc_route_table ec2_vpc_subnet ec2_vpc_subnet_info
ISSUE TYPE


Docs Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8 PR should be backported to the stable-8 branch mergeit Merge the PR (SoftwareFactory)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants