NGSS Maven Tiles Catalog
|
Deprecation and Retirement
Recommended actions for container tiles ( We recommend updating to the new "baseless" tiles introduced in version This alleviates a common complaint with maintaining the See Migrating to Baseless Image Tiles for more info. Recommended actions for all other tiles Continue to use the most recent releases of |
This page provides a comprehensive catalog of all available NGSS Maven Tiles organized by category.
Foundation Tiles
base-service-tile
Establishes core service properties, Docker repository configuration, and build conventions inherited by container and deployment tiles.
Container Build Tiles
docker-maven-plugin-tile
Complete Docker build solution using fabric8 plugin with predefined base image (ckm/java-service-base:4.3.5), automatic JAR assembly, and multi-environment support.
Code Generation and Documentation Tiles
filegen-tile
Configures ngss-filegen-maven-plugin for project file generation. The generate-all-files profile runs copier-init (DevOps/Backstage templates), init-vv-yaml, and generate-dibr-readme.
|
Filegen 6.x and Copier Requirement Starting with ngss-maven-tiles 2.10.0, the default filegen version is 6.x which uses Copier for DevOps and Backstage template generation. Copier must be installed before running Copier-based goals. See the Filegen 6.0 Migration Guide for details. |
# Install Copier (required for filegen 6.x copier goals)
pipx install copier
# Or see the Copier Installation Guide for Docker and other options
Deprecated Goals
The following legacy goals are deprecated and replaced by Copier-based templates:
| Deprecated Goal | Replacement | Notes |
|---|---|---|
|
|
Use ngss-devops-template |
|
||
|
||
|
|
Use ngss-backstage-template |
Current Goals
| Goal | Description |
|---|---|
|
Initialize Copier templates (devops, backstage) |
|
Update existing Copier templates with 3-way merge |
|
Generate |
|
Initialize/update |
|
Generate |
|
Generate Flyway database migration scripts |
dibr-readme-generator-tile
Generates the DIBR (Deployment, Installation, Backout, Rollback) guide for deployment processes with automated deployment instructions.
fly_way-generator-tile
Automates Flyway database migration script generation and configuration for database schema version management.
backstage-tile (deprecated)
Copies project documentation files to the Backstage docs/ directory for TechDocs integration. Uses filegen goals copy-backstage-readme, copy-backstage-changelog, and copy-openapi-json.
This tile is deprecated. Going forward, for generating the initial catalog-info.yaml and Backstage structure, use copier-init -Dcopier.template=backstage from the filegen-tile instead, and for updating Backstage files, use copier-update with the Backstage template (or include the backstage-copier-update-tile in your pom.xml tiles config for automatic update per build).
|
backstage-copier-update-tile
Runs copier-update for the Backstage template during the generate-sources phase with --defaults (non-interactive mode). This tile is intended for local builds to automatically update Backstage documentation files without prompting.
Configuration:
The tile runs filegen:copier-update with:
-
template=backstage- Updates only the Backstage template -
defaults=true- Uses default values without prompting (non-interactive) -
phase=generate-sources- Runs early in the build lifecycle
Example usage:
<tiles>
<tile>gov.va.mobile.tools.maven:backstage-copier-update-tile:${ngss-maven-tiles.version}</tile>
</tiles>
Requires Copier to be installed and the .copier-answers/backstage.yaml file to exist (from a previous copier-init).
|