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

Add a warning to build --secret docs #4823

Merged
merged 1 commit into from
May 30, 2023
Merged

Add a warning to build --secret docs #4823

merged 1 commit into from
May 30, 2023

Conversation

rijenkii
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Add a warning about potentially confusing behavior of --secret flag.
Not sure how to correctly word it and if it is event a good place for said warning, but oh well.

How to verify it

Which issue(s) this PR fixes:

Fixes #4822

Special notes for your reviewer:

Does this PR introduce a user-facing change?

None

@openshift-ci openshift-ci bot added the kind/documentation Categorizes issue or PR as related to documentation. label May 30, 2023
@@ -697,6 +697,8 @@ The secret will be mounted in the container at the default location of `/run/sec
To later use the secret, use the --mount flag in a `RUN` instruction within a `Containerfile`:

`RUN --mount=type=secret,id=mysecret cat /run/secrets/mysecret`

Warning: Changing the contents of secret files will not trigger a rebuild of layers that use said secrets.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be called Note not Warning since this is expected behavior :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Force-pushed a fix.

@flouthoc
Copy link
Collaborator

Could you please sign the comment and add following string in commit message [NO NEW TESTS NEEDED]

@rijenkii
Copy link
Contributor Author

Done, I think.

@rhatdan
Copy link
Member

rhatdan commented May 30, 2023

Looks like you need to cleanup dangling spaces.

[NO NEW TESTS NEEDED]

Signed-off-by: rijenkii <[email protected]>
@rijenkii
Copy link
Contributor Author

A lot of stuff can go wrong while adding a single line...
Fixed, I hope.

Copy link
Collaborator

@flouthoc flouthoc left a comment

Choose a reason for hiding this comment

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

LGTM

@openshift-ci
Copy link
Contributor

openshift-ci bot commented May 30, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: flouthoc, rijenkii

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@rhatdan
Copy link
Member

rhatdan commented May 30, 2023

/lgtm
/hold

@rhatdan
Copy link
Member

rhatdan commented May 30, 2023

/hold cancel

@openshift-merge-robot openshift-merge-robot merged commit c3b7dcb into containers:main May 30, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 29, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved kind/documentation Categorizes issue or PR as related to documentation. lgtm locked - please file new issue/PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

build: Change of --secret does not trigger layer rebuild
4 participants