[CI:DOCS] Add information about .containerignore to podman build man page #11898
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: rhatdan 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 |
openshift-ci
bot
added
the
approved
| The .containerignore and .dockerignore files have the exact same syntax, if both | ||
| are in the same directory podman build will using .containerignore. | ||
|
|
||
| Users can specify a series of Unix shell globals in a .containerignore file to | ||
| identify files/directories to exclude. |
There was a problem hiding this comment.
will BE using? Or will use?
| @@ -984,7 +988,7 @@ mechanism: | |||
|
|
|||
| Exclude all doc files except Help.doc from the image. | |||
|
|
|||
| This functionality is compatible with the handling of .dockerignore files | |||
| This functionality is compatible with the handling of .containerignore files | |||
| described here: | |||
|
|
|||
There was a problem hiding this comment.
The following link to the docker website for the description of .dockerignore can be replaced with a link to the description of .containerignore - e.g. https://github.com/containers/buildah/blob/main/docs/containerignore.5.md .
There was a problem hiding this comment.
This changeset in its completeness states explicitly, that .dockerignore and .containerignore have the same syntax, but it does not say, that the semantics is the same. Nevertheless the equivalent semantics is implied by the context.
The above paragraph states that .containerignore and .docherignore are compatible. This more or less means that the files are interchangeable. The end of the man-page has a SEE ALSO section, pointing to .containerignore(5), which I guess rendered in HTML will contain the right hyperlink.
I propose deleting the next link, as it is included by the SEE ALSO section behind .containerignore(5) and is therefore supposed to be hyperlinked.
I propose deleting the above paragraph, as it should be clear by now, that .containerignore and .dockerignore are interchangeable.
rhatdan
force-pushed
the
docs
branch
2 times, most recently
from
323f75f to
52d1113
Compare
| Podman uses the content to exclude files and directories from the context | ||
| directory, when executing COPY and ADD directives in the | ||
| Containerfile/Dockerfile | ||
|
|
||
| Users can specify a series of Unix shell globals in a .dockerignore file to | ||
| The .containerignore and .dockerignore files have the same syntax; if both | ||
| are in the context directory, podman build will use .containerignore. |
There was a problem hiding this comment.
Suggestion: '...will use only .containerignore` (boldface mine for emphasis; not needed in actual document). Without 'only', it is ambiguous whether the sentence means "will use .containerignore in addition to .dockerignore".
| @@ -1009,10 +1013,10 @@ If you are using `useradd` within your build script, you should pass the | |||
| useradd to stop creating the lastlog file. | |||
|
|
|||
| ## SEE ALSO | |||
| podman(1), buildah(1), containers-certs.d(5), containers-registries.conf(5), crun(8), runc(8), useradd(8), podman-ps(1), podman-rm(1) | |||
| podman(1), buildah(1), containers-certs.d(5), containers-registries.conf(5), crun(8), runc(8), useradd(8), podman-ps(1), podman-rm(1), Containerfile(5), .containerignore(5) | |||
There was a problem hiding this comment.
I think (but am not sure) this should be containerignore(5), without the dot?
Cleanup some other errors in the podman build man page. Also slip a link between .dockerignore and containerignore.5 man page Signed-off-by: Daniel J Walsh <[email protected]>
|
LGTM |
|
|
||
| $ podman build -t imageName . | ||
|
|
||
| $ podman build --tls-verify=true -t imageName -f Dockerfile.simple . | ||
| $ podman build --tls-verify=true -t imageName -f Containrfile.simple . |
There was a problem hiding this comment.
Yes, let's please fix this before merge.
| The .containerignore and .dockerignore files use the same syntax; if both | ||
| are in the context directory, podman build will only use .containerignore. | ||
|
|
||
| Users can specify a series of Unix shell globals in a .containerignore file to |
There was a problem hiding this comment.
Ugh. This is not your change, looks like it already existed, but this should be globs, not globals.
|
Two nits, neither one showstoppers, and I know the CI gauntlet is brutal these days, so I'll let you choose whether to merge or fix. /lgtm |
openshift-ci
bot
added
the
do-not-merge/hold
|
IDK why this didn't merge for @edsantiago , but the two nits he found should be picked before merging. |
|
/hold cancel |
openshift-ci
bot
removed
the
do-not-merge/hold
github-actions
bot
added
the
locked - please file new issue/PR
Cleanup some other errors in the podman build man page.
Also slip a link between .dockerignore and containerignore.5 man page
Signed-off-by: Daniel J Walsh [email protected]
What this PR does / why we need it:
How to verify it
Which issue(s) this PR fixes:
Special notes for your reviewer: