keycloak_user_federation: add explanation and example to vendor option

[clovis-monmousseau]

trafficstars

SUMMARY

Added an example to the vendor option. The description of the option is not verbose enough and can lead to problems. More precisely, you need to enter the "short name" of the vendor and not the full name. For instance, you need to enter rhds for "Red Hat Directory Server". If you enter "Red Hat Directory Server" in the option, the user federation will be created but the vendor will remain blank.

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

community.general.keycloak_user_federation module vendor option

[ansibullbot]

cc @eikef @laurpaum @ndclt click here for bot help

[github-actions[bot]]

Docs Build 📝

Thank you for contribution!✨

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

[felixfontein]

@clovis-monmousseau could you please take a look at the review comment?

[felixfontein]

@clovis-monmousseau you simply marked the comment as resolved without any comment, or without accepting the suggestion. That's not really nice.

Also please note that the C(...) formatting for values is mandatory (see https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#linking-and-other-format-macros-within-module-documentation).

[clovis-monmousseau]

@felixfontein, I thought that resolving the comment meant that I agreed with your suggestion. I didn't mean to be rude here. I am quite new to this, so thanks for your time and advice. I have now applied your suggestion, and I see the Verify REUSE check is failing. Not sure how to fix this.

[felixfontein]

@felixfontein, I thought that resolving the comment meant that I agreed with your suggestion. I didn't mean to be rude here. I am quite new to this, so thanks for your time and advice.

No problem, that's why I wanted to check with you :)

I have now applied your suggestion, and I see the Verify REUSE check is failing. Not sure how to fix this.

You could rebase to the current main branch to make it pass, but it doesn't matter (as I'll ignore it). The reason is that as opposed as the other tests, this one isn't rebasing automatically. The advantage is that I don't have to manually allow the test to run for every PR / new commit by someone who hasn't contributed before; the disadvantage is that it is showing wrong results for PRs that were branched off main before the necessary fixes were done in main. So basically that problem will go away eventually as all older PRs are closed or merged, but for now it can be misleading / annoying.

Since I can directly see that your change isn't going to violate that test I'm going to ignore it :)

[felixfontein]

@clovis-monmousseau thanks for your contribution!

[patchback[bot]]

Backport to stable-4: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-4/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893

Backported as https://github.com/ansible-collections/community.general/pull/5335

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

[patchback[bot]]

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893

Backported as https://github.com/ansible-collections/community.general/pull/5336

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

[patchback[bot]]

Backport to stable-4: 💔 creation of the backport PR failed

❌ Backport PR branch: patchback/backports/stable-4/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893

Validation Failed: 'A pull request already exists for ansible-collections:patchback/backports/stable-4/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893.'

Backporting merged PR #4893 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-4/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893 upstream/stable-4
   

4. Now, cherry-pick PR #4893 contents into that branch:

   $ git cherry-pick -x 7b86fa6a7dcf76f0211317513631fe24797a06c1
   

   If it'll yell at you with something like fatal: Commit 7b86fa6a7dcf76f0211317513631fe24797a06c1 is a merge but no -m option was given., add -m 1 as follows intead:

   $ git cherry-pick -m1 -x 7b86fa6a7dcf76f0211317513631fe24797a06c1
   

5. At this point, you'll probably encounter some merge conflicts. You must resolve them in to preserve the patch from PR #4893 as close to the original as possible.
6. Push this branch to your fork on GitHub:

   $ git push origin patchback/backports/stable-4/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893
   

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[bot]]

Backport to stable-5: 💔 creation of the backport PR failed

❌ Backport PR branch: patchback/backports/stable-5/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893

Validation Failed: 'A pull request already exists for ansible-collections:patchback/backports/stable-5/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893.'

Backporting merged PR #4893 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-5/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893 upstream/stable-5
   

4. Now, cherry-pick PR #4893 contents into that branch:

   $ git cherry-pick -x 7b86fa6a7dcf76f0211317513631fe24797a06c1
   

   If it'll yell at you with something like fatal: Commit 7b86fa6a7dcf76f0211317513631fe24797a06c1 is a merge but no -m option was given., add -m 1 as follows intead:

   $ git cherry-pick -m1 -x 7b86fa6a7dcf76f0211317513631fe24797a06c1
   

5. At this point, you'll probably encounter some merge conflicts. You must resolve them in to preserve the patch from PR #4893 as close to the original as possible.
6. Push this branch to your fork on GitHub:

   $ git push origin patchback/backports/stable-5/7b86fa6a7dcf76f0211317513631fe24797a06c1/pr-4893
   

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.