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

Docs linting fixups #1100

Merged

Conversation

tremble
Copy link
Contributor

@tremble tremble commented Apr 27, 2022

SUMMARY

While testing out linting/validation of the generated docs, a number of issues were highlighted.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/modules/aws_batch_job_definition.py
plugins/modules/aws_config_rule.py
plugins/modules/aws_secret.py
plugins/modules/aws_waf_rule.py
plugins/modules/cloudfront_invalidation.py
plugins/modules/ec2_placement_group_info.py
plugins/modules/iam_user.py
plugins/modules/route53_health_check.py
plugins/modules/s3_sync.py

ADDITIONAL INFORMATION

@tremble tremble added backport-1.5 PR should be backported to the stable-1.5 branch backport-2 PR should be backported to the stable-2 branch backport-3 PR should be backported to the stable-3 branch labels Apr 27, 2022
@ansibullbot ansibullbot added community_review docs module module owner_pr PR created by owner/maintainer plugins plugin (any type) labels Apr 27, 2022
@tremble tremble added the mergeit Merge the PR (SoftwareFactory) label Apr 28, 2022
@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit c5363d5 into ansible-collections:main Apr 28, 2022
@patchback
Copy link

patchback bot commented Apr 28, 2022

Backport to stable-1.5: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply c5363d5 on top of patchback/backports/stable-1.5/c5363d56dc761e6a8b53be7d0ebd243af20adec7/pr-1100

Backporting merged PR #1100 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible-collections/community.aws.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-1.5/c5363d56dc761e6a8b53be7d0ebd243af20adec7/pr-1100 upstream/stable-1.5
  4. Now, cherry-pick PR Docs linting fixups #1100 contents into that branch:
    $ git cherry-pick -x c5363d56dc761e6a8b53be7d0ebd243af20adec7
    If it'll yell at you with something like fatal: Commit c5363d56dc761e6a8b53be7d0ebd243af20adec7 is a merge but no -m option was given., add -m 1 as follows intead:
    $ git cherry-pick -m1 -x c5363d56dc761e6a8b53be7d0ebd243af20adec7
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Docs linting fixups #1100 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-1.5/c5363d56dc761e6a8b53be7d0ebd243af20adec7/pr-1100
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

@patchback
Copy link

patchback bot commented Apr 28, 2022

Backport to stable-2: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2/c5363d56dc761e6a8b53be7d0ebd243af20adec7/pr-1100

Backported as #1103

🤖 @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 Apr 28, 2022
Docs linting fixups

SUMMARY
While testing out linting/validation of the generated docs, a number of issues were highlighted.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/modules/aws_batch_job_definition.py
plugins/modules/aws_config_rule.py
plugins/modules/aws_secret.py
plugins/modules/aws_waf_rule.py
plugins/modules/cloudfront_invalidation.py
plugins/modules/ec2_placement_group_info.py
plugins/modules/iam_user.py
plugins/modules/route53_health_check.py
plugins/modules/s3_sync.py
ADDITIONAL INFORMATION

Reviewed-by: Markus Bergholz <[email protected]>
(cherry picked from commit c5363d5)
@patchback
Copy link

patchback bot commented Apr 28, 2022

Backport to stable-3: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-3/c5363d56dc761e6a8b53be7d0ebd243af20adec7/pr-1100

Backported as #1104

🤖 @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 Apr 28, 2022
Docs linting fixups

SUMMARY
While testing out linting/validation of the generated docs, a number of issues were highlighted.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/modules/aws_batch_job_definition.py
plugins/modules/aws_config_rule.py
plugins/modules/aws_secret.py
plugins/modules/aws_waf_rule.py
plugins/modules/cloudfront_invalidation.py
plugins/modules/ec2_placement_group_info.py
plugins/modules/iam_user.py
plugins/modules/route53_health_check.py
plugins/modules/s3_sync.py
ADDITIONAL INFORMATION

Reviewed-by: Markus Bergholz <[email protected]>
(cherry picked from commit c5363d5)
softwarefactory-project-zuul bot pushed a commit that referenced this pull request Apr 28, 2022
[PR #1100/c5363d56 backport][stable-3] Docs linting fixups

This is a backport of PR #1100 as merged into main (c5363d5).
SUMMARY
While testing out linting/validation of the generated docs, a number of issues were highlighted.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/modules/aws_batch_job_definition.py
plugins/modules/aws_config_rule.py
plugins/modules/aws_secret.py
plugins/modules/aws_waf_rule.py
plugins/modules/cloudfront_invalidation.py
plugins/modules/ec2_placement_group_info.py
plugins/modules/iam_user.py
plugins/modules/route53_health_check.py
plugins/modules/s3_sync.py
ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell <None>
softwarefactory-project-zuul bot pushed a commit that referenced this pull request Apr 28, 2022
[PR #1100/c5363d56 backport][stable-2] Docs linting fixups

This is a backport of PR #1100 as merged into main (c5363d5).
SUMMARY
While testing out linting/validation of the generated docs, a number of issues were highlighted.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/modules/aws_batch_job_definition.py
plugins/modules/aws_config_rule.py
plugins/modules/aws_secret.py
plugins/modules/aws_waf_rule.py
plugins/modules/cloudfront_invalidation.py
plugins/modules/ec2_placement_group_info.py
plugins/modules/iam_user.py
plugins/modules/route53_health_check.py
plugins/modules/s3_sync.py
ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell <None>
@tremble tremble deleted the docs/linting branch July 7, 2022 19:24
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Docs linting fixups

SUMMARY
While testing out linting/validation of the generated docs, a number of issues were highlighted.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/modules/aws_batch_job_definition.py
plugins/modules/aws_config_rule.py
plugins/modules/aws_secret.py
plugins/modules/aws_waf_rule.py
plugins/modules/cloudfront_invalidation.py
plugins/modules/ec2_placement_group_info.py
plugins/modules/iam_user.py
plugins/modules/route53_health_check.py
plugins/modules/s3_sync.py
ADDITIONAL INFORMATION

Reviewed-by: Markus Bergholz <[email protected]>

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@c5363d5
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Docs linting fixups

SUMMARY
While testing out linting/validation of the generated docs, a number of issues were highlighted.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/modules/aws_batch_job_definition.py
plugins/modules/aws_config_rule.py
plugins/modules/aws_secret.py
plugins/modules/aws_waf_rule.py
plugins/modules/cloudfront_invalidation.py
plugins/modules/ec2_placement_group_info.py
plugins/modules/iam_user.py
plugins/modules/route53_health_check.py
plugins/modules/s3_sync.py
ADDITIONAL INFORMATION

Reviewed-by: Markus Bergholz <[email protected]>

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@c5363d5
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
…ons#1100)

unit-tests: module_utils/test_rds.py requires py37+

contextlib.nullcontext was introduced with Python 3.7

Reviewed-by: Alina Buzachis <None>
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
…nsible-collections#1098)

inventory/aws_ec2: drop := operator because we still support py3.6

Depends-On: ansible/ansible-zuul-jobs#1649
Depends-On: ansible-collections#1100
The operator was included with Python 3.8.
See: https://docs.python.org/3/whatsnew/3.8.html#assignment-expressions

Reviewed-by: Alina Buzachis <None>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-1.5 PR should be backported to the stable-1.5 branch backport-2 PR should be backported to the stable-2 branch backport-3 PR should be backported to the stable-3 branch community_review docs mergeit Merge the PR (SoftwareFactory) module module owner_pr PR created by owner/maintainer plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants