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

More PyGithub dep and license housekeeping #15853

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

AlanCoding
Copy link
Member

SUMMARY

Yesterday, in some panicked fixing, I added a duplicated license after @arrestle added the same PyNaCl, because I used capitals and she used lowercase. So this removes one of them. I favor the capitalization, and tests allow it... but the source check doesn't allow capitals.

Additionally:

This implements the comment from @webknjaz

https://github.com/ansible/awx/pull/15850/files/5d167b60d83b73ebfdd31a243f0d9a7bf1a478eb#diff-2d88edd924033b49783dcb4f93a0ed0ec8aae0b6aac3bad984a2c1d323b93c37

The correct thing to do would be to depend on awx-plugins-core [credentials-github-app] that declares the dependency.

This PR does that.

Ran ./updater.sh run, which proved the theory to be correct.

ISSUE TYPE
  • Bug, Docs Fix or other nominal change
COMPONENT NAME
  • API

@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Feb 21, 2025
@AlanCoding AlanCoding requested a review from arrestle February 21, 2025 15:48
Copy link

codecov bot commented Feb 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.29%. Comparing base (fa099fe) to head (da1703b).

✅ All tests successful. No failed tests found.

Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

Honestly, I'm surprised that all the other extras that awx-plugins declares aren't depended on.. They definitely should be. I assume awx works because it happens to depend on the same things but I'll break if it stops.

@@ -2,5 +2,5 @@ git+https://github.com/ansible/system-certifi.git@devel#egg=certifi
# Remove pbr from requirements.in when moving ansible-runner to requirements.in
git+https://github.com/ansible/ansible-runner.git@devel#egg=ansible-runner
django-ansible-base @ git+https://github.com/ansible/django-ansible-base@devel#egg=django-ansible-base[rest-filters,jwt_consumer,resource-registry,rbac,feature-flags]
awx-plugins-core @ git+https://github.com/ansible/awx-plugins.git@devel#egg=awx-plugins-core
awx-plugins-core @ git+https://github.com/ansible/awx-plugins.git@devel#egg=awx-plugins-core[credentials-github-app]
Copy link
Member

Choose a reason for hiding this comment

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

This is a bit of a Frankenstein syntax. It's better to use the normal dep+extras spec. The #egg bit is a part of older syntax that existed pre pkg @ url, almost as a hack. The ecosystem doesn't even use the concept of eggs anymore except for when the legacy abstractions leak into the UI...

Here you go:

Suggested change
awx-plugins-core @ git+https://github.com/ansible/awx-plugins.git@devel#egg=awx-plugins-core[credentials-github-app]
awx-plugins-core [credentials-github-app] @ git+https://github.com/ansible/awx-plugins.git

Copy link
Member Author

Choose a reason for hiding this comment

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

That argument would seem to apply equally to django-ansible-base specification on the line before. Do you agree?

Copy link
Member

Choose a reason for hiding this comment

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

Absolutely! I just didn't want to enlarge the PR scope.

Copy link
Member

Choose a reason for hiding this comment

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

I think that having awx-plugins-core [credentials-github-app] here too should work. It should have the abstract spec that would be augmented with git additionally in some envs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants