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

*_info - improve RETURN block of docs #855

Conversation

jatorcasso
Copy link
Contributor

@jatorcasso jatorcasso commented Jun 1, 2022

Depends-On: #856

SUMMARY

Fixes #843

Can things like checking for a period after description be added to our sanity checks?

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
  • aws_ax_info
  • aws_caller_info
  • aws_s3
  • cloudformation_info
  • ec2_eni_info
  • ec2_group
  • ec2_group_info
  • ec2_instance_info
  • ec2_key
  • ec2_metadata_facts
  • ec2_snapshot_info
  • ec2_spot_instance
  • ec2_spot_instance_info
  • ec2_tag
  • ec2_tag_info
  • ec2_vpc_dhcp_option_info
  • ec2_vpc_endpoint_info
  • ec2_vpc_endpoint_service_info
  • ec2_vpc_igw_info
  • ec2_vpc_nat_gateway
  • ec2_vpc_nat_gateway_info
  • ec2_vpc_net_info
  • ec2_vpc_route_table_info
  • elb_classic_lb

@github-actions
Copy link

github-actions bot commented Jun 1, 2022

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 failed.

✔️ ansible-galaxy-importer SUCCESS in 4m 19s
✔️ build-ansible-collection SUCCESS in 5m 16s
ansible-test-sanity-aws-ansible-python38 FAILURE in 9m 54s
✔️ ansible-test-sanity-aws-ansible-2.9-python38 SUCCESS in 11m 41s
ansible-test-sanity-aws-ansible-2.11-python38 FAILURE in 9m 36s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 7m 08s
✔️ ansible-test-splitter SUCCESS in 2m 32s
integration-amazon.aws-1 TIMED_OUT in 1h 00m 44s
integration-amazon.aws-2 FAILURE in 32m 38s
integration-amazon.aws-3 FAILURE in 23m 25s
✔️ integration-amazon.aws-4 SUCCESS in 29m 37s
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
⚠️ integration-community.aws-1 SKIPPED
⚠️ integration-community.aws-2 SKIPPED
⚠️ integration-community.aws-3 SKIPPED
⚠️ integration-community.aws-4 SKIPPED
⚠️ integration-community.aws-5 SKIPPED
⚠️ integration-community.aws-6 SKIPPED
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED

@softwarefactory-project-zuul
Copy link
Contributor

Build failed.

✔️ ansible-galaxy-importer SUCCESS in 3m 47s
✔️ build-ansible-collection SUCCESS in 4m 39s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 9m 45s
✔️ ansible-test-sanity-aws-ansible-2.9-python38 SUCCESS in 12m 58s
✔️ ansible-test-sanity-aws-ansible-2.11-python38 SUCCESS in 10m 03s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 5m 20s
✔️ ansible-test-splitter SUCCESS in 2m 41s
✔️ integration-amazon.aws-1 SUCCESS in 41m 25s
integration-amazon.aws-2 FAILURE in 25m 53s
integration-amazon.aws-3 FAILURE in 26m 25s
✔️ integration-amazon.aws-4 SUCCESS in 29m 13s
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
✔️ integration-community.aws-1 SUCCESS in 47m 01s
✔️ integration-community.aws-2 SUCCESS in 7m 40s
✔️ integration-community.aws-3 SUCCESS in 20m 34s
integration-community.aws-4 TIMED_OUT in 1h 00m 38s
integration-community.aws-5 FAILURE in 39m 07s
integration-community.aws-6 TIMED_OUT in 1h 00m 45s
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED

@jatorcasso
Copy link
Contributor Author

recheck

@softwarefactory-project-zuul
Copy link
Contributor

Build failed.

✔️ ansible-galaxy-importer SUCCESS in 4m 04s
✔️ build-ansible-collection SUCCESS in 4m 48s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 9m 19s
✔️ ansible-test-sanity-aws-ansible-2.9-python38 SUCCESS in 11m 48s
✔️ ansible-test-sanity-aws-ansible-2.11-python38 SUCCESS in 13m 27s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 09s
✔️ ansible-test-splitter SUCCESS in 2m 37s
integration-amazon.aws-1 TIMED_OUT in 1h 00m 52s
✔️ integration-amazon.aws-2 SUCCESS in 24m 29s
integration-amazon.aws-3 RETRY_LIMIT in 1m 33s
✔️ integration-amazon.aws-4 SUCCESS in 31m 54s
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
✔️ integration-community.aws-1 SUCCESS in 50m 48s
✔️ integration-community.aws-2 SUCCESS in 8m 40s
integration-community.aws-3 RETRY_LIMIT in 1m 32s
✔️ integration-community.aws-4 SUCCESS in 45m 19s
integration-community.aws-5 FAILURE in 37m 56s
integration-community.aws-6 TIMED_OUT in 1h 00m 45s
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED

@jatorcasso
Copy link
Contributor Author

recheck

@softwarefactory-project-zuul
Copy link
Contributor

Build failed.

✔️ ansible-galaxy-importer SUCCESS in 5m 35s
✔️ build-ansible-collection SUCCESS in 4m 57s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 9m 29s
✔️ ansible-test-sanity-aws-ansible-2.9-python38 SUCCESS in 14m 09s
✔️ ansible-test-sanity-aws-ansible-2.11-python38 SUCCESS in 9m 39s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 03s
✔️ ansible-test-splitter SUCCESS in 2m 29s
✔️ integration-amazon.aws-1 SUCCESS in 43m 43s
✔️ integration-amazon.aws-2 SUCCESS in 17m 19s
✔️ integration-amazon.aws-3 SUCCESS in 25m 41s
✔️ integration-amazon.aws-4 SUCCESS in 30m 17s
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
✔️ integration-community.aws-1 SUCCESS in 47m 35s
✔️ integration-community.aws-2 SUCCESS in 8m 05s
✔️ integration-community.aws-3 SUCCESS in 20m 14s
✔️ integration-community.aws-4 SUCCESS in 47m 50s
integration-community.aws-5 FAILURE in 49m 49s
integration-community.aws-6 TIMED_OUT in 1h 00m 41s
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED

@jatorcasso
Copy link
Contributor Author

recheck

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 4m 23s
✔️ build-ansible-collection SUCCESS in 4m 49s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 9m 16s
✔️ ansible-test-sanity-aws-ansible-2.9-python38 SUCCESS in 15m 41s
✔️ ansible-test-sanity-aws-ansible-2.11-python38 SUCCESS in 10m 02s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 20s
✔️ ansible-test-splitter SUCCESS in 2m 33s
✔️ integration-amazon.aws-1 SUCCESS in 37m 29s
✔️ integration-amazon.aws-2 SUCCESS in 18m 28s
✔️ integration-amazon.aws-3 SUCCESS in 23m 46s
✔️ integration-amazon.aws-4 SUCCESS in 31m 34s
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
⚠️ integration-community.aws-1 SKIPPED
⚠️ integration-community.aws-2 SKIPPED
⚠️ integration-community.aws-3 SKIPPED
⚠️ integration-community.aws-4 SKIPPED
⚠️ integration-community.aws-5 SKIPPED
⚠️ integration-community.aws-6 SKIPPED
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED

Copy link
Collaborator

@jillr jillr left a comment

Choose a reason for hiding this comment

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

Other than the typo LGTM - this should have a second review though because it's quite a lot of text to review

plugins/modules/ec2_vpc_dhcp_option_info.py Outdated Show resolved Hide resolved
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 3m 58s
✔️ build-ansible-collection SUCCESS in 4m 44s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 12m 10s
✔️ ansible-test-sanity-aws-ansible-2.9-python38 SUCCESS in 10m 24s
✔️ ansible-test-sanity-aws-ansible-2.11-python38 SUCCESS in 8m 51s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 5m 49s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 5m 57s
✔️ ansible-test-splitter SUCCESS in 2m 28s
✔️ integration-amazon.aws-1 SUCCESS in 33m 59s
✔️ integration-amazon.aws-2 SUCCESS in 22m 58s
✔️ integration-amazon.aws-3 SUCCESS in 24m 43s
✔️ integration-amazon.aws-4 SUCCESS in 30m 27s
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
✔️ integration-community.aws-1 SUCCESS in 5m 54s
⚠️ integration-community.aws-2 SKIPPED
⚠️ integration-community.aws-3 SKIPPED
⚠️ integration-community.aws-4 SKIPPED
⚠️ integration-community.aws-5 SKIPPED
⚠️ integration-community.aws-6 SKIPPED
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED

@tremble tremble self-requested a review June 8, 2022 05:14
plugins/modules/aws_s3.py Outdated Show resolved Hide resolved
Copy link
Contributor

@tremble tremble left a comment

Choose a reason for hiding this comment

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

From experience, you may need to split out the changes to a couple of the slower tests to avoid timeouts. We used to manually balance the groups of tests, and while the new automatic balancing is much better than it used to be slow tests can still cause problems.

@ansibullbot ansibullbot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR new_module New module new_plugin New plugin and removed community_review labels Jun 8, 2022
jatorcasso and others added 2 commits June 8, 2022 11:21
@jatorcasso jatorcasso force-pushed the _info/update-return-data branch from 201ebec to af4c47d Compare June 8, 2022 15:22
@ansibullbot ansibullbot added community_review and removed needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR new_module New module new_plugin New plugin labels Jun 8, 2022
@jatorcasso
Copy link
Contributor Author

recheck

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 4m 19s
✔️ build-ansible-collection SUCCESS in 4m 46s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 9m 41s
✔️ ansible-test-sanity-aws-ansible-2.9-python38 SUCCESS in 12m 20s
✔️ ansible-test-sanity-aws-ansible-2.11-python38 SUCCESS in 8m 39s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 20s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 6m 17s
✔️ ansible-test-splitter SUCCESS in 2m 25s
✔️ integration-amazon.aws-1 SUCCESS in 31m 15s
✔️ integration-amazon.aws-2 SUCCESS in 19m 10s
✔️ integration-amazon.aws-3 SUCCESS in 21m 27s
✔️ integration-amazon.aws-4 SUCCESS in 38m 48s
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
✔️ integration-community.aws-1 SUCCESS in 7m 19s
⚠️ integration-community.aws-2 SKIPPED
⚠️ integration-community.aws-3 SKIPPED
⚠️ integration-community.aws-4 SKIPPED
⚠️ integration-community.aws-5 SKIPPED
⚠️ integration-community.aws-6 SKIPPED
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED

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

Build succeeded (gate pipeline).

✔️ ansible-galaxy-importer SUCCESS in 3m 55s
✔️ build-ansible-collection SUCCESS in 4m 58s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 10m 27s
✔️ ansible-test-sanity-aws-ansible-2.9-python38 SUCCESS in 10m 26s
✔️ ansible-test-sanity-aws-ansible-2.11-python38 SUCCESS in 8m 36s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 5m 57s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 5m 57s
✔️ ansible-test-splitter SUCCESS in 2m 31s
✔️ integration-amazon.aws-1 SUCCESS in 39m 39s
✔️ integration-amazon.aws-2 SUCCESS in 23m 25s
✔️ integration-amazon.aws-3 SUCCESS in 19m 48s
✔️ integration-amazon.aws-4 SUCCESS in 30m 37s
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
✔️ integration-community.aws-1 SUCCESS in 5m 10s
⚠️ integration-community.aws-2 SKIPPED
⚠️ integration-community.aws-3 SKIPPED
⚠️ integration-community.aws-4 SKIPPED
⚠️ integration-community.aws-5 SKIPPED
⚠️ integration-community.aws-6 SKIPPED
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit caaf7e8 into ansible-collections:main Jun 9, 2022
jatorcasso added a commit to jatorcasso/amazon.aws that referenced this pull request Jun 27, 2022
*_info - improve RETURN block of docs

Depends-On: ansible-collections#856
SUMMARY
Fixes ansible-collections#843
Can things like checking for a period after description be added to our sanity checks?
ISSUE TYPE

Docs Pull Request

COMPONENT NAME

aws_ax_info
aws_caller_info
aws_s3
cloudformation_info
ec2_eni_info
ec2_group
ec2_group_info
ec2_instance_info
ec2_key
ec2_metadata_facts
ec2_snapshot_info
ec2_spot_instance
ec2_spot_instance_info
ec2_tag
ec2_tag_info
ec2_vpc_dhcp_option_info
ec2_vpc_endpoint_info
ec2_vpc_endpoint_service_info
ec2_vpc_igw_info
ec2_vpc_nat_gateway
ec2_vpc_nat_gateway_info
ec2_vpc_net_info
ec2_vpc_route_table_info
elb_classic_lb

Reviewed-by: Jill R <None>
Reviewed-by: Mark Chappell <None>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community_review docs integration tests/integration mergeit Merge the PR (SoftwareFactory) module module plugins plugin (any type) tests tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

*_info modules missing/inaccurate RETURN data
5 participants