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

New mechanism for including/excluding files during collection build #22

Closed
sivel opened this issue Aug 18, 2022 · 2 comments
Closed

New mechanism for including/excluding files during collection build #22

sivel opened this issue Aug 18, 2022 · 2 comments

Comments

@sivel
Copy link

sivel commented Aug 18, 2022

We merged a new opt-in feature yesterday, allowing a galaxy.yml to specify MANIFEST.in directives instead of utilizing build_ignore.

The effective outcome is that manifest: is exclusive by default, whereas build_ignore: is inclusive by default. When using manifest: there are a default set of directives that should meet the majority of users use cases, as opposed to what build_ignore: had provided. Simply adding manifest: to galaxy.yml and ensuring no build_ignore: is specified will opt into this behavior.

You can read more about this at https://docs.ansible.com/ansible-core/devel/dev_guide/developing_collections_distributing.html#manifest-directives

This will be included in 2.14, and as of now requires installing the optional dependency distlib. We plan to discuss whether we make distlib a hard dependency, and promote manifest: as the default, but for now, it is opt-in and an optional dependency.

@D3DeFi
Copy link

D3DeFi commented Aug 31, 2022

I am not sure what files we would be skipping. Perhaps only:

  • docs/
  • tests/
  • docker-compose.yml

I wonder if tests are omitted by default. Need to check when I have a chance.

Any other ideas what to skip and if something at all?

@sivel
Copy link
Author

sivel commented Aug 31, 2022

docs and tests are purposefully included in the default manifest directives. docker-compose.yml would not be included in the root, but would be if it happens to appear in a place where .yml files are included. If you read the documentation link provided above, it outlines the default directives in use.

Please feel free to create a discussion at https://github.com/ansible-collections/news-for-maintainers/discussions if you would like to discuss this further.

@ansible-collections ansible-collections locked as resolved and limited conversation to collaborators Mar 22, 2023
@mattclay mattclay closed this as completed Apr 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants