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 option to exclude hidden dirs and files #804

Closed

Conversation

gaelgatelement
Copy link

@gaelgatelement gaelgatelement commented Jul 19, 2023

Reasoning : In our CI, the build artifact contains dependencies in a hidden directory. Because of this, reuse fails to validate using lint because its detecting issues in the dependencies directory.

By adding this option, we are able to explicitly tell reuse to exclude hidden directories, which contains dependencies in our case.

@mxmehl
Copy link
Member

mxmehl commented Jul 20, 2023

Thank you for your submission. It would have been great if you had created an issue beforehand, as we will most likely not accept this PR. Let me explain why:

We don't want to add flags to lint that make a difference on the compliance status, especially if they make it easier to reach compliance

As per specification, a repository can be either REUSE compliant or non-compliant. All exceptions, ignored files etc. are equal for everyone, so it doesn't make a difference whether you, I, a CI or the API lint the project. Only the output can be different (like JSON or no output).

The problem with flags that can alter the compliance status is that there would be multiple compliance definitions, based on the custom flags or hacks that one applies locally. That's not wanted and would render the actual goal of REUSE void: make licensing and copyright easy and understandable for humans and machines alike.

Side note 1: we should document this somewhere as this question appears quite often

Side note 2: --include-submodules and --include-meson-subprojects may have an effect on compliance, but these non-defaults make reaching compliance harder, not easier.

@mxmehl mxmehl closed this Jul 20, 2023
@mxmehl mxmehl added the wontfix This will not be worked on label Jul 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants