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

Update requirements.yaml collections git based syntax #2257

Closed
wants to merge 5 commits into from

Conversation

aapjeisbaas
Copy link

wanted to install a forked collection repo and the stated syntax didn't work for me

this syntax is what works for me

@ansible-documentation-bot ansible-documentation-bot bot added the new_contributor This PR is the first contribution by a new community member. label Dec 5, 2024
@ansible-documentation-bot
Copy link
Contributor

Thanks for your Ansible docs contribution! We talk about Ansible documentation on Matrix at #docs:ansible.im if you ever want to join us and chat about the docs! We meet on Matrix every Tuesday. See the Ansible calendar for meeting details. We welcome additions to our weekly agenda items too. You can add the dawgs-meeting tag to a forum topic to bring it up at the next meeting.

Copy link
Contributor

@s-hertel s-hertel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original example is valid. What issue did you have with it?

The suggestion only works due to a bug. source is for type: galaxy, to download a namespace.name requirement from a specific Galaxy server. It's a bug currently that name and source can be conflated for type git/dir/subdirs - it gives the illusion the name is separately configurable.

While version: 1.0.0 is fine for a repo that publishes a tag matching "1.0.0", the example intentionally uses "devel" to show that this is not a collection version, but the commitish at which to build the collection from the repo contents. The version of the installed collection is determined by the contents of the repo, not the commitish in the requirements.yml.

@aapjeisbaas
Copy link
Author

I'm sorry for the confusion the error was on my side.
I assumed the syntax was wrong as a git like destination seems a bit strange as a name.
And the syntax I added in the pull request is what I got working.

@samccann samccann closed this Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new_contributor This PR is the first contribution by a new community member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants