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

[a-n]*.py: normalize doc_fragments #9422

Merged

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Dec 27, 2024

SUMMARY

Normalize doc blocks in doc_fragments.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/doc_fragments/alicloud.py
plugins/doc_fragments/attributes.py
plugins/doc_fragments/auth_basic.py
plugins/doc_fragments/bitbucket.py
plugins/doc_fragments/consul.py
plugins/doc_fragments/dimensiondata.py
plugins/doc_fragments/dimensiondata_wait.py
plugins/doc_fragments/django.py
plugins/doc_fragments/emc.py
plugins/doc_fragments/gitlab.py
plugins/doc_fragments/hpe3par.py
plugins/doc_fragments/hwc.py
plugins/doc_fragments/ibm_storage.py
plugins/doc_fragments/influxdb.py
plugins/doc_fragments/ipa.py
plugins/doc_fragments/keycloak.py
plugins/doc_fragments/ldap.py
plugins/doc_fragments/lxca_common.py
plugins/doc_fragments/manageiq.py
plugins/doc_fragments/nomad.py

@ansibullbot ansibullbot added docs docs_fragments docs_fragments plugin (shared docs) plugins plugin (any type) labels Dec 27, 2024
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Dec 27, 2024
plugins/doc_fragments/ldap.py Outdated Show resolved Hide resolved
plugins/doc_fragments/ldap.py Outdated Show resolved Hide resolved
russoz and others added 2 commits December 27, 2024 23:58
@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Dec 27, 2024
@felixfontein felixfontein merged commit ed09295 into ansible-collections:main Dec 27, 2024
129 checks passed
Copy link

patchback bot commented Dec 27, 2024

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

❌ Failed to cleanly apply ed09295 on top of patchback/backports/stable-9/ed092956ba8bed85bbb141b6fdc90c1b19e5b503/pr-9422

Backporting merged PR #9422 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.general.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-9/ed092956ba8bed85bbb141b6fdc90c1b19e5b503/pr-9422 upstream/stable-9
  4. Now, cherry-pick PR [a-n]*.py: normalize doc_fragments #9422 contents into that branch:
    $ git cherry-pick -x ed092956ba8bed85bbb141b6fdc90c1b19e5b503
    If it'll yell at you with something like fatal: Commit ed092956ba8bed85bbb141b6fdc90c1b19e5b503 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x ed092956ba8bed85bbb141b6fdc90c1b19e5b503
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR [a-n]*.py: normalize doc_fragments #9422 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-9/ed092956ba8bed85bbb141b6fdc90c1b19e5b503/pr-9422
  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.

@felixfontein
Copy link
Collaborator

@russoz thanks!

Copy link

patchback bot commented Dec 27, 2024

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/ed092956ba8bed85bbb141b6fdc90c1b19e5b503/pr-9422

Backported as #9428

🤖 @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 Dec 27, 2024
* [a-n]*.py: normalize doc_fragments

* Update plugins/doc_fragments/ldap.py

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/doc_fragments/ldap.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit ed09295)
@russoz russoz deleted the docfrag-a-n-docs branch December 27, 2024 21:48
felixfontein pushed a commit that referenced this pull request Dec 27, 2024
…ments (#9428)

[a-n]*.py: normalize doc_fragments (#9422)

* [a-n]*.py: normalize doc_fragments

* Update plugins/doc_fragments/ldap.py

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/doc_fragments/ldap.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit ed09295)

Co-authored-by: Alexei Znamensky <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch docs_fragments docs_fragments plugin (shared docs) docs plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants