feat: provide input to optionally mask output docker password #491
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
therealdwright
force-pushed
the
correctly-mask-secrets
branch
8 times, most recently
from
f01522b
to
0020a24
Compare
This will allow the user to specify an optional input to mask the Docker password from being leaked in workflow logs via either explicitly printing or running a job in debug mode. Since many users rely on the output, the default behaviour has been false to ensure this is not a breaking change. This also re-arranges the inputs throughout the code and in the GH action spec to be in alphabetical order as a styling improvement. Signed-off-by: danielwright@bitgo.com <danielwright@bitgo.com>
therealdwright
force-pushed
the
correctly-mask-secrets
branch
from
0020a24
to
4e598b2
Compare
|
As a general comment, I would prefer my change default to be |
michaelb990
approved these changes
Aug 8, 2023
There was a problem hiding this comment.
Thanks for the contribution @therealdwright! A couple small wording tweaks, otherwise this looks good to me.
| #### Login to Amazon ECR Private, then build and push a Docker image masking the password: | ||
|
|
||
| > [!WARNING] | ||
| > Setting mask-password to true will prevent the password GitHub output from being shared between separate jobs. |
There was a problem hiding this comment.
Suggested change
| > Setting mask-password to true will prevent the password GitHub output from being shared between separate jobs. | |
| > Setting mask-password to true will prevent the password used to login to ECR from being shared between jobs. |
Comment on lines
+13
to
+14
| Mask the docker password to prevent it being printed to logs to std-out. This will prevent the | ||
| password GitHub output from being shared between separate jobs. |
There was a problem hiding this comment.
Suggested change
| Mask the docker password to prevent it being printed to logs to std-out. This will prevent the | |
| password GitHub output from being shared between separate jobs. | |
| Mask the docker password to prevent it from appearing in debug logs. This will prevent the | |
| password used to login to Amazon ECR from being shared between jobs. |
|
Shoot, I pressed the wrong button. We'll tweak these in a follow-up PR and get a release out shortly. |
therealdwright
added a commit
to therealdwright/amazon-ecr-login
that referenced
this pull request
Aug 8, 2023
This commit addresses PR feedback left in aws-actions#491. There are no functional changes in this commit, simply minor wording changes to the readme.md and action.yaml Signed-off-by: danielwright@bitgo.com <danielwright@bitgo.com>
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.
This will allow the user to specify an optional input to mask the Docker password from being leaked in workflow logs via either explicitly printing or running a job in debug mode. Since many users rely on the output, the default behaviour has been false to ensure this is not a breaking change.
This also re-arranges the inputs throughout the code and in the GH action spec to be in alphabetical order as a styling improvement.
Issue #
Closes #485
Description of changes:
mask-passwordcase and update existing tests