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

fix links to containerignore doc #5402

Merged
merged 2 commits into from
Mar 18, 2024

Conversation

Pvlerick
Copy link
Contributor

@Pvlerick Pvlerick commented Mar 14, 2024

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Documentation

How to verify it

N/A

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

In the selection of the ignore file, the logic is wrong; the comment here https://github.com/containers/buildah/blob/main/pkg/parse/parse.go#L1290 says that .containerignore will be preferend but the code obviously does the opposite since the .dockerignore is checked for in the second if.

Proving test: https://github.com/Pvlerick/buildah/blob/container-ignore-file-priority/pkg/parse/parse_test.go#L233

However, changing this logic is a breaking change, and this [file].dockerignore/[file].containerignore is not documented (at least I didn't find any mention of it)

Does this PR introduce a user-facing change?

NO


Signed-off-by: Philippe Vlérick <pvlerick@gmail.com>
@openshift-ci openshift-ci bot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 14, 2024
@@ -89,7 +89,7 @@ buildah add containerID 'passwd' 'certs.d' /etc

## FILES

### .containerignore
### .containerignore/.dockerignore
Copy link
Collaborator

Choose a reason for hiding this comment

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

This appears to be a path on quick look maybe make it .containerignore or .dockerignore. Anyways is there any need to include .dockerignore in this heading ? I think the text below describes talks about .dockerignore.

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.

One nit above otherwise PR LGTM

Copy link
Member

@TomSweeneyRedHat TomSweeneyRedHat left a comment

Choose a reason for hiding this comment

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

LGTM once the nit is cleansed.

Co-authored-by: Tom Sweeney <tsweeney@redhat.com>
Signed-off-by: Philippe Vlérick <pvlerick@gmail.com>
@Pvlerick
Copy link
Contributor Author

Suggestion applied.

FYI, I aligned it with what I could find here: https://github.com/containers/podman/blob/main/docs/source/markdown/podman-build.1.md.in#L635

@Pvlerick
Copy link
Contributor Author

BTW no comment on the ignore files priorities discrepancies between the doc and the code ? :-)

@rhatdan
Copy link
Member

rhatdan commented Mar 18, 2024

/approve
LGTM

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
/lgtm
/approve

Copy link
Contributor

openshift-ci bot commented Mar 18, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: flouthoc, Pvlerick, 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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-bot openshift-merge-bot bot merged commit ccde5d5 into containers:main Mar 18, 2024
36 checks passed
@Pvlerick Pvlerick deleted the build-doc-link-fix branch March 18, 2024 15:36
@stale-locking-app stale-locking-app bot locked as resolved and limited conversation to collaborators Jun 17, 2024
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.

4 participants