Ansible-Galaxy requirements.yml hiccups due to repo structure

ryanmerolle commented 3 years ago

Issue Type

[X] Bug Report
[ ] EOS Configuration rendering error
[ ] Documentation Issue Report

Summary

Throwing this out there given this repo is not exactly setup like most ansible-galaxy collection repos. This is more of an issue for users who want to track to devel branch using a requirements.yml file.

Component Name

airsta.avd

Steps to reproduce

The below functionality as documented by Ansible, does not work as is given galaxy expects the manifast.json / galaxy.yml file in the root of the repo.

---
collections:
   - name: https://github.com/aristanetworks/ansible-avd.git
     type: git
     version: devel

The workaround is to append the path to the actual collection source as below:

---
collections:
   - name: https://github.com/aristanetworks/ansible-avd.git#ansible_collections/arista/avd
     type: git
     version: devel

Expected results

Unfortunately when downloading the tarball version of the devel branch, you cannot specify the required path for ansible-galaxy to search for the collection because it expects an ansible-galaxy compliant artifact (quoted from the Ansible community in libre.chat)

collections:
   - name: https://github.com/aristanetworks/ansible-avd/archive/devel.tar.gz

The install should work as is, but again because of the non-standard collection repo directory structure, it does not.

Actual results

The above requirements.yml item will not take a path like the git repo item will. As such the following error message shows up.

Downloading https://github.com/aristanetworks/ansible-avd/archive/devel.tar.gz to /home/user1/.ansible/tmp/ansible-local-752h74l7azr/tmpe2biem1a
ERROR! Collection at '/home/user1/.ansible/tmp/ansible-local-752h74l7azr/tmpe2biem1a/devel.tar2m4g0k1y.gz' does not contain the required file MANIFEST.json.

Additional Context & Thoughts

The only reason why I care about this is because:

This is the only collection I need to manually specify the collection path in my requirements.yml file.
My internal gitlab-ci build processes only have access to a nexus app proxy for github projects, so I cannot install from the git link, and only the tarballs.

Options:

I can submit an issue to the ansible-galaxy project to see if we can specify a search path, but given the comments from the chat, I am doubtful that will be accepted.
I can download the tarball before, extract it, and point to the local path for the install in the requirements file.
This repo can be reorganized (I recognize the lift and the small ROI to standardize around ansbile-galaxy collection model for tracking against devel branch in an easier manner for only a handful of users.

ryanmerolle commented 3 years ago

This is sort of a pain right now because 3.0.0rc1 is not listed on galaxy and you cannot install using galaxy via git or a tar, you have to manually add this rc1 release for testing.

github-actions[bot] commented 2 years ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 15 days

aristanetworks / avd