Add PyHC Actions for PHEP 3 compliance and environment compatibility#1
Closed
Add PyHC Actions for PHEP 3 compliance and environment compatibility#1
Conversation
Owner
Author
|
❌❌ Both the checks failed because it couldn't find a |
Owner
Author
|
✅✅ Update: Fixed in v1.0.2 of the actions! 🎉 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hey guys, Shawn from PyHC here!
Can I politely ask you to be guinea pigs for these two new GitHub Actions I developed? 😁 I'm asking all the core packages first. The actions check for (1) compliance with PHEP 3 and (2) compatibility with the PyHC Environment. The idea is that they'll pass ✅ if there are no problems, but error/warn when problems arise.
E.g., you'll get a red ❌ if:
You'll get ignorable warnings⚠️ if:
If this goes well, I'd love to live in a future where all PyHC packages use these actions. I think it'd help keep everyone on the same page and be a huge win for interoperability!
Summary
This PR adds two GitHub Actions workflows from heliophysicsPy/pyhc-actions:
1. PHEP 3 Compliance Checker
Validates that the package meets PHEP 3 requirements:
2. PyHC Environment Compatibility Checker
Detects dependency conflicts with the PyHC Environment to ensure the package can be installed alongside other PyHC packages:
Trigger Schedule
Both workflows run on:
Notes
uvdoing most the heavy lifting.Feedback
Please share any feedback about how I've implemented these! I've tested them as extensively as I can, but let me know if you experience buggy behavior. I want these to be helpful, not cumbersome.