ansible-collections / community.general

Ansible Community General Collection
https://galaxy.ansible.com/ui/repo/published/community/general/
GNU General Public License v3.0
816 stars 1.5k forks source link

Feature. Add chapter 'Lists of dictionaries' to docsite #8482

Closed vbotka closed 3 months ago

vbotka commented 3 months ago
SUMMARY

Add filter_guide -> abstract_informations -> lists_of_dictionaries:

ISSUE TYPE
COMPONENT NAME

filter_guide-abstract_informations-lists_of_dictionaries.rst filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst

ADDITIONAL INFORMATION

Created helpers:

Create RST files by running the below command in the helper/*_keys directory

shell> ansible-playbook playbook.yml
ansibullbot commented 3 months ago

@vbotka This PR was evaluated as a potentially problematic PR for the following reasons:

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on Libera.chat IRC

click here for bot help

vbotka commented 3 months ago

For the record: There seems to be a problem with needs_rebase

shell> git pull --rebase upstream main
From https://github.com/ansible-collections/community.general
 * branch                main       -> FETCH_HEAD
The current branch feature-docsite-keep_keys is up to date.
shell> git push --force-with-lease
Everything up-to-date
felixfontein commented 3 months ago

I think needs_rebase is added because of More than 50 changed files.; usually that number of changed files implies that someone screwed up a rebase and added some random unrelated commits. In this case it's safe to ignore :-)

vbotka commented 3 months ago

... it's safe to ignore :-)

Thank you for the comment!

felixfontein commented 3 months ago

@vbotka this now has a conflict.

vbotka commented 3 months ago

... now has a conflict.

This file shouldn't be included in the PR. I rebased the PR and resolved the conflict. Sorry for the noise. I tested all helpers and docsite. This PR should be ready. Thank you!

ansibullbot commented 3 months ago

The test licenses failed with 12 errors:

docs/docsite/helper/keep_keys/tests.yml.sha1:0:0: found no copyright notice
docs/docsite/helper/keep_keys/tests.yml.sha1:0:0: must have at least one license
docs/docsite/helper/keep_keys/keep_keys.rst.sha1:0:0: found no copyright notice
docs/docsite/helper/keep_keys/keep_keys.rst.sha1:0:0: must have at least one license
docs/docsite/helper/remove_keys/remove_keys.rst.sha1:0:0: found no copyright notice
docs/docsite/helper/remove_keys/remove_keys.rst.sha1:0:0: must have at least one license
docs/docsite/helper/remove_keys/tests.yml.sha1:0:0: found no copyright notice
docs/docsite/helper/remove_keys/tests.yml.sha1:0:0: must have at least one license
docs/docsite/helper/replace_keys/tests.yml.sha1:0:0: found no copyright notice
docs/docsite/helper/replace_keys/tests.yml.sha1:0:0: must have at least one license
docs/docsite/helper/replace_keys/replace_keys.rst.sha1:0:0: found no copyright notice
docs/docsite/helper/replace_keys/replace_keys.rst.sha1:0:0: must have at least one license

click here for bot help

felixfontein commented 3 months ago

For files that do not support comments, you can add a .license file. See tests/sanity/ignore-*.txt.license for examples.

vbotka commented 3 months ago

For files that do not support comments, you can add a .license file. See tests/sanity/ignore-*.txt.license for examples.

Thank you! I used this and simplified templates.

patchback[bot] commented 3 months ago

Backport to stable-9: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-9/caecb2297fbf8cfb9ae80926ead10b4fb11a003f/pr-8482

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

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

felixfontein commented 3 months ago

@vbotka thanks for your contribution!

vbotka commented 2 months ago

@vbotka thanks for your contribution!

@felixfontein thank you!