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

Collection Artifacts contain errant files #148

Closed
sivel opened this issue Jul 17, 2020 · 8 comments
Closed

Collection Artifacts contain errant files #148

sivel opened this issue Jul 17, 2020 · 8 comments
Assignees
Labels
bug Something isn't working

Comments

@sivel
Copy link

sivel commented Jul 17, 2020

It appears as though the collection generated from this repo contains a full python virtual environment, as well as many other files that shouldn't be included in the build.

Some other examples:

  • .vscode/settings.json
  • tests/output/junit/meraki_site_to_site_vpn-tbo31dqq-1585418559.9924767.xml
  • .DS_Store

See the attached file for a full list.

cisco.meraki.txt

@kbreit
Copy link
Collaborator

kbreit commented Jul 17, 2020

@sivel How do I tell the collection to not have the files which shouldn't be there?

@sivel
Copy link
Author

sivel commented Jul 17, 2020

In Ansible 2.10 you can use build_ignore in galaxy.yml https://docs.ansible.com/ansible/devel/dev_guide/collections_galaxy_meta.html#collections-galaxy-meta

Otherwise, you may want to consider having a separate clean directory where you build the artifacts, separate of where you do your development. Potentially even building and publishing via CI.

@kbreit
Copy link
Collaborator

kbreit commented Jul 17, 2020

@sivel Could you take a look at #149 and let me know if it, at least at a glance, covers everything it should. Here's what I'm seeing when I extract a new tarball.

(venv) temp [2.0/build_ignore●] % tar -xvzf cisco-meraki-1.3.2.tar.gz
x MANIFEST.json
x FILES.json
x plugins/
x plugins/doc_fragments/
x plugins/doc_fragments/__init__.py
x plugins/doc_fragments/meraki.py
x plugins/action/
x plugins/inventory/
x plugins/module_utils/
x plugins/module_utils/network/
x plugins/module_utils/network/meraki/
x plugins/module_utils/network/meraki/__init__.py
x plugins/module_utils/network/meraki/meraki.py
x plugins/filter/
x plugins/modules/
x plugins/modules/meraki_organization.py
x plugins/modules/meraki_config_template.py
x plugins/modules/meraki_device.py
x plugins/modules/meraki_network.py
x plugins/modules/meraki_content_filtering.py
x plugins/modules/meraki_mr_l3_firewall.py
x plugins/modules/meraki_switchport.py
x plugins/modules/meraki_mx_site_to_site_firewall.py
x plugins/modules/meraki_site_to_site_vpn.py
x plugins/modules/meraki_mx_l3_firewall.py
x plugins/modules/meraki_vlan.py
x plugins/modules/meraki_nat.py
x plugins/modules/__init__.py
x plugins/modules/meraki_static_route.py
x plugins/modules/meraki_switch_storm_control.py
x plugins/modules/meraki_switch_stack.py
x plugins/modules/meraki_firewalled_services.py
x plugins/modules/meraki_webhook.py
x plugins/modules/meraki_admin.py
x plugins/modules/meraki_intrusion_prevention.py
x plugins/modules/meraki_management_interface.py
x plugins/modules/meraki_ssid.py
x plugins/modules/meraki_ms_link_aggregation.py
x plugins/modules/meraki_switch_access_list.py
x plugins/modules/meraki_mx_l7_firewall.py
x plugins/modules/meraki_malware.py
x plugins/modules/meraki_mx_uplink.py
x plugins/modules/meraki_syslog.py
x plugins/modules/meraki_snmp.py

@kbreit kbreit added the bug Something isn't working label Jul 17, 2020
@kbreit kbreit self-assigned this Jul 17, 2020
@sivel
Copy link
Author

sivel commented Jul 17, 2020

That looks good. Thanks for the help. As of now the ansible-2.10.0a3 package contained the full venv referenced before.

I honestly don't know what the expectation is about delivering the tests too, but I'm fine with it this way.

@kbreit
Copy link
Collaborator

kbreit commented Jul 18, 2020

@sivel Do I need this as part of master to be picked up by your work?

@sivel
Copy link
Author

sivel commented Jul 20, 2020

@kbreit I am not specifically doing anything. It was completely accidental that I ran across this.

Until this is used to build the collection artifact, the Ansible 2.10 release will contain your virtualenv. I am not part of the team that owns that process, but I did make them aware of this.

@kbreit
Copy link
Collaborator

kbreit commented Jul 20, 2020

I will release a new 1.3.2 version today to remedy this. Thank you.

@kbreit
Copy link
Collaborator

kbreit commented Jul 22, 2020

I released v1.3.2. yesterday and that should have the files removed. If there are files in the package which shouldn't be there, let me know.

@kbreit kbreit closed this as completed Jul 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants