Ignores

During the merge process of a template into a target directory plybuild ignores the following files:

Default ignore

Regardless what is defined in the ignore files, plybuild will ignore filenames matching:

[
    "Application",
    "plybuild.json",
    ".plybuild.ignore",
    ".gitignore",
    ".mvn",
    "mvnw",
    "mvnw.cmd",
    ".idea",
    ".iml"
]

Ignoring filesnames matching Application

The first entry Application, in the list above, enables plybuild to ignore files like WebApplication.kt or FooApplication.java. Files which are typically files containing the @SpringBootApplication. It is important that no template contain critical code inside of these files, as they are ignored during the merge process.

Definitions in ignore files

plybuild by default reads the .gitignore file from the template, and ignores all the files matching. In addition a plybuild.ignore file can be added for files which should exist in the version control, but not be part of the template during merging.

Example .plybuild.ignore

FooController.kt

Note: absolute path is not necessary

Example .gitignore

HELP.md
target