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

Improve podman build secrets docs / Makefile validatepr description #25111

Merged

Conversation

hdub-tech
Copy link
Contributor

Description

TL;DR:

  1. Enhance the podman build --secret documentation and add examples.
  2. Add validatepr to make help output.

Details: After struggling to find a way to build an image without writing a secret to disk first, I did some hunting. This PR is basically a copy/paste from buildah-build.1, with some tweaks to appease the podman project linter and with the addition of some Examples. (I plan to submit a similar PR to containers/buildah to update the --secret help output and add the examples there as well).

Note: This "Fixes" #23388 if you go strictly by the Title. However, if you read the comments, it looks like the OP is looking for something more along the lines of using --secret WITHOUT needing --mount=type=secret modifications to a Containerfile. This is why I omitted the issue number from the commit description. I am more than willing to modify this if requested.

Testing

  • make binaries passes

  • make docs passes and edits to secret.image.md appear in podman-build.1.md and podman-farm-build.1.md.

    Screenshot from 2025-01-23 20-57-05

    Screenshot from 2025-01-23 20-58-19

    Screenshot from 2025-01-23 22-31-52

    image

  • make validatepr passes

  • make help shows validatepr

    Screenshot from 2025-01-23 22-07-59

Does this PR introduce a user-facing change?

None

@hdub-tech
Copy link
Contributor Author

I confess, I did not run the full suite of tests before I put this PR up, but I'm pretty sure the 4 failures here are unrelated to my changes? Are there flaky tests here? I noticed 3 of those were timeouts.

@Luap99
Copy link
Member

Luap99 commented Jan 24, 2025

Yes these are flakes, your branch seems to based on an older commit. Please rebase to the latest main that should help in terms of machine testing on macos 6ee51c5

(In general before pushing a PR it is always a good idea to rebase to the latest main)

@hdub-tech
Copy link
Contributor Author

Ha that's embarrassing! Usually I do make sure I've pulled latest main. I started this update weeks ago and made the mistake of trying to wrap it up late last night while tired. My apologies, I'll push a rebase later today.

Copy link
Member

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

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

LGTM
@containers/podman-maintainers PTAL

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 27, 2025
Copy link
Member

@giuseppe giuseppe 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 openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 27, 2025
Copy link
Contributor

openshift-ci bot commented Jan 27, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: giuseppe, hdub-tech, Luap99

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

@openshift-merge-bot openshift-merge-bot bot merged commit 4ea199d into containers:main Jan 28, 2025
88 checks passed
@hdub-tech hdub-tech deleted the docs/podman-build-secrets branch January 28, 2025 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. release-note-none
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants