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 few quick tips to readme.md to avoid longer read through and add more exclusions #567

Merged
merged 2 commits into from
May 27, 2023

Conversation

hazendaz
Copy link
Collaborator

No description provided.

makes it easier than trying to find in documentation and the header types isn't linked from documentation.  For those that need quick reference, I generally list both these in pom usage.  So it only makes sense to make it up front and clear.
- Add .cer - certificate
- Add .der - digital certificate
- Add .ear - ear archive
- Add .war - war archive
- Add .tar.bz3 - bzip 3
- Add new explicit location to eingore license all together.
@hazendaz hazendaz self-assigned this May 27, 2023
@hazendaz
Copy link
Collaborator Author

Exclusions added...

For certificate types, more recently added and most often manually setup on ignores now

  • Add .cer - certificate
  • Add .der - digital certificate

For some use cases, its possible projects may be importing ear and war file types too just like jars so this helps there or they have them checked in - very specific use case where no formal hosting exists. This happens with many vendors supporting various industries where they don't have artifactory, sonatype, etc.

  • Add .ear - ear archive
  • Add .war - war archive

Newer bzip type

  • Add .tar.bz3 - bzip 3

Many users continually ask to skip files and the list of files needed to skip is rather extensive at times with many cases no file extensions. To easily resolve that, for 2 to 3 years, we have implemented the following which has greatly reduced need for downstream (non super pom) usage of license plugin to ignore wide area needed without any further configuration.

  • Add new explicit location to ignore license all together. '/unlicensed/'

I did notice in reviewing the current exclusions we are still certainly missing quite a bit that should be excluded. However, I don't have personal experience in those exclusions needs at the moment so I leaned only towards adding what I'm already overriding in my super pom at work where I'd like to cleanup and reduce more the configuration of the plugin to mostly defaults.

For the readme, this is for the lazy in all of us :) Just want a quick where is this stuff hidden in the plugin. I've been doing this in our super pom for years now and continually have to go there to find it. For our users, they typically don't even look in the super pom and if pointed here at best they will find the defaults eventually but not the types as easily as looking directly at the code. So this achieves quickly getting them there as they are more likely to go look at the github plugin.

@mathieucarbou mathieucarbou merged commit 1b163fc into mathieucarbou:master May 27, 2023
@hazendaz hazendaz added this to the 4.3 milestone Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants