ansible-galaxy - Don't copy a file from a skeleton if file.j2 also exists

[mafalb]

SUMMARY

If a file.j2 exists in the skeleton and also file (without .j2 extension), e.g.:

README.md
README.md.j2

ensure that only README.md.j2 is copied
This is a minor performance tweak, but there is more to it. See below...

ISSUE TYPE

• Feature Pull Request

ADDITIONAL INFORMATION

Until now it was unspecified which file it makes into the initialized collection or role, because the directory tree is walked with os.walk() and the order is unspecified.

With the PR we have predictable results which makes some use cases possible if the skeleton is located in it's own git repository

README.md describes the usage of the skeleton and will be rendered by github UI
README.md.j2 is copied over into the collection/role

another example would be a github workflow

.github/workflows/CI.yml -> used by github actions to test my skeleton
.github/workflows/CI.yml.j2 -> template for my initialized collection/role

commands affected:

$ ansible-galaxy collection init --collection-skeleton my-skeleton local.mycollection
$ ansible-galaxy role init --role-skeleton my-role-skeleton myrole

[s-hertel]

After discussing internally, I've changed about allowing mixing files where the skeleton lives with actual skeleton files. It's probably safest to just give an error if there are conflicting files (this will fix the bug with getting an unpredictable result), and the caller can either fix the skeleton, or use GALAXY_COLLECTION_SKELETON_IGNORE/GALAXY_ROLE_SKELETON_IGNORE if the intention is actually to ignore one of the files.