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

Mention requirements more clearly in README #224

Merged
merged 1 commit into from
Oct 5, 2022

Conversation

colindean
Copy link
Contributor

I've nearly always had git available anywhere I was using Peru but found while setting up a new CI pipeline that Peru calls git via subprocess for caching.

This dependency is undeclared in the Homebrew formula but is declared in the AUR package. I'll update the Homebrew formula.

@colindean
Copy link
Contributor Author

Opened Homebrew/homebrew-core#95810

@oconnor663
Copy link
Member

The first paragraph of the "Installation" section mentions this requirement. Do you think we should clarify it?

@colindean
Copy link
Contributor Author

Yes. I missed it and Homebrew missed it although whoever wrote The Homebrew formula may have simply assumed that whatever git Homebrew is relying on was adequate and didn't need to be an explicit dependency.

Minimally, I think it's worth clarifying that it's needed even if you're not pulling from a git repository.

@colindean
Copy link
Contributor Author

I need to resolve the conflicts created by my other PR getting merged so I'll revisit this I'm going to finish brewing my coffee.

I've nearly always had git available anywhere I was using Peru but found while setting up a new CI pipeline that Peru calls git via subprocess for caching.
@colindean colindean changed the title Mention git requirement in README Mention requirements more clearly in README Feb 25, 2022
@colindean
Copy link
Contributor Author

Fixed and ready for review. I chose to list the requirements and then call it out again in the pip section in case someone looks it up fast and misses the previous list.

@colindean
Copy link
Contributor Author

This is ready!

1 similar comment
@colindean
Copy link
Contributor Author

This is ready!

@oconnor663 oconnor663 merged commit dd7668c into buildinspace:master Oct 5, 2022
@oconnor663
Copy link
Member

Thank you! Sorry for dropping the ball on this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants