-
Notifications
You must be signed in to change notification settings - Fork 6
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
Install cisagov/skeleton-python-library directly with pip
#188
Merged
mcdonnnj
merged 3 commits into
improvement/update_Dockerfile_configuration
from
improvement/install_skeleton-python-library_directly
Feb 21, 2024
Merged
Install cisagov/skeleton-python-library directly with pip
#188
mcdonnnj
merged 3 commits into
improvement/update_Dockerfile_configuration
from
improvement/install_skeleton-python-library_directly
Feb 21, 2024
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
Instead of downloading the source archive, extracting it, and then installing it with pip we instead just let pip directly install the package.
Since we are now installing cisagov/skeleton-python-library directly with pip we no longer need these OS packages.
Now that we are not overwriting the internal Python package file the text we look for must match what is output by default. The Docker Compose secret configuration is left in place to continue to serve as an example and to be leveraged for a future update to cisagov/skeleton-python-library that can provide similar functionality to what was removed in this project.
mcdonnnj
added
breaking change
This issue or pull request involves changes to existing functionality
improvement
This issue or pull request will add or improve functionality, maintainability, or ease of use
labels
Feb 20, 2024
mcdonnnj
requested review from
dav3r,
felddy,
jasonodoom and
jsf9k
as code owners
February 20, 2024 15:56
jsf9k
approved these changes
Feb 20, 2024
@mcdonnnj Did you mean to enable auto-merge on this skeleton PR? |
Ah, my bad - I see that this PR is not to the |
dav3r
approved these changes
Feb 21, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 👍
mcdonnnj
merged commit Feb 21, 2024
aa39972
into
improvement/update_Dockerfile_configuration
16 checks passed
mcdonnnj
deleted the
improvement/install_skeleton-python-library_directly
branch
February 21, 2024 13:50
cisagovbot
pushed a commit
that referenced
this pull request
Sep 25, 2024
Remove @jasonodoom as a codeowner
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
breaking change
This issue or pull request involves changes to existing functionality
improvement
This issue or pull request will add or improve functionality, maintainability, or ease of use
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 pull request updates the installation of cisagov/skeleton-python-library to be installed directly with
pip
.Note
I am creating this pull request against a branch that will represent a larger body of work. This branch will later have a pull request against
develop
once the body of work is completed.Warning
This change breaks the Docker composition's ability to change the secret message that is printed. I am hoping to restore this functionality by changing part of how cisagov/skeleton-python-library works in the future.
💭 Motivation and context
There is no reason we shouldn't let
pip
handle the retrieval, decompression, and installation of a source package on its own. This is a cleaner approach and involves fewer dependencies in the generated Docker image which in turn gives us a smaller image (130MiB vs. 223MiB).🧪 Testing
Automated tests pass.
✅ Pre-approval checklist