Add setup.py to the Cache Keys for the GitHub Actions Workflow #78
Conversation
This file contains 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
This adds a hash of `setup.py` to the cache keys used in the GitHub Actions workflow for Python projects.
mcdonnnj
added
the
improvement
dav3r
approved these changes
Jun 7, 2021
The other cache keys for our GHA jobs are in the format '**/<filename>' so that any file with that name is used in the repository. However, for Python packages they may have a 'setup.py' as part of their internal codebase that does not impact environment requirements. As a result we only want to use the 'setup.py' that is in the root of the repository and is used to install the package. Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Excellent suggestion. I've added a comment to every cache key declaration in 449eef4. Please let me know if you have any feedback about the comment. |
Looks perfect to me - thanks for adding that. |
jsf9k
approved these changes
Jun 10, 2021
mcdonnnj
added
the
blocked
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.
🗣 Description
This adds
setup.pyto the files hashed to create the cache keys used in our GitHub Actions workflow. I am intentionally not using**/setup.pyso only thesetup.pyin the root directory of the repository (which should be the base path forGITHUB_WORKSPACEwhen running an Action) is used. This prevents unexpected behavior if a package contains asetup.py.💭 Motivation and context
Since we direct requirements for our Python projects to be stored in
setup.pywe should invalidate a cache based on changes to that file. The file generally will not change much outside of requirements changes once a project is past it's initial implementation.🧪 Testing
I confirmed that in the GHA run the cache key is updated to include a hash for
setup.py.📷 Screenshots (if appropriate)
✅ Checklist