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.

Sign up for GitHub

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

Jump to bottom

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
Merged

Add few quick tips to readme.md to avoid longer read through and add more exclusions #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
888cac2
[ci] Add quick links to readme
hazendaz May 27, 2023
ad50855
[excludes] Improve on default exclusions
hazendaz May 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# LIcense Maven Plugin

- __Build Status:__ [![Java CI](https://github.com/mathieucarbou/license-maven-plugin/actions/workflows/ci.yaml/badge.svg)](https://github.com/mathieucarbou/license-maven-plugin/actions/workflows/ci.yaml)
- __Issues:__ https://github.com/mathieucarbou/license-maven-plugin/issues
- __Documentation:__ https://mycila.carbou.me/license-maven-plugin/
- __License:__ [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)

## Quick Links ##

- [Default Excludes](https://github.com/mathieucarbou/license-maven-plugin/blob/master/license-maven-plugin/src/main/java/com/mycila/maven/plugin/license/Default.java)
- [Header Types](https://github.com/mathieucarbou/license-maven-plugin/blob/master/license-maven-plugin/src/main/java/com/mycila/maven/plugin/license/header/HeaderType.java)

## Quick Tip ##

Often necessary to exclude a number of files that would otherwise grow the exclusion list on setup and do not fit with the default exclusions provided by this plugin. To exclude complete sections, please into a special folder to do exactly that.

```**/unlicensed/**```
8 changes: 8 additions & 0 deletions license-maven-plugin/src/main/java/com/mycila/maven/plugin/license/Default.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,19 +173,24 @@ private Default() {

// Security files
"**/*.asc",
"**/*.cer",
"**/*.der",
"**/*.jks",
"**/*.keytab",
"**/*.lic",
"**/*.p12",
"**/*.pub",

// binary files - archives
"**/*.ear",
"**/*.jar",
"**/*.war",
"**/*.zip",
"**/*.rar",
"**/*.tar",
"**/*.tar.gz",
"**/*.tar.bz2",
"**/*.tar.bz3",
"**/*.gz",
"**/*.7z",

Expand Down Expand Up @@ -251,6 +256,9 @@ private Default() {
"**/*.docx",
"**/*.ppt",
"**/*.pptx",

// Explicit Folder to Entirely Ignore
"**/unlicensed/**"
};

}