Skip to content

alexengrig/spring-banner-gradle-plugin

Repository files navigation

spring-banner-gradle-plugin

Gradle Plugin Portal GitHub

Github Actions

Spring Banner Gradle Plugin for generating banner.txt.

See customizing the Spring Banner .

                    _                   __                               
   _________  _____(_)___  ____ _      / /_  ____ _____  ____  ___  _____
  / ___/ __ \/ ___/ / __ \/ __ `/_____/ __ \/ __ `/ __ \/ __ \/ _ \/ ___/
 (__  ) /_/ / /  / / / / / /_/ /_____/ /_/ / /_/ / / / / / / /  __/ /    
/____/ .___/_/  /_/_/ /_/\__, /     /_.___/\__,_/_/ /_/_/ /_/\___/_/     
    /_/                 /____/  ____                 __            _     
          ____ __________ _____/ / /__        ____  / /_  ______ _(_)___ 
         / __ `/ ___/ __ `/ __  / / _ \______/ __ \/ / / / / __ `/ / __ \
        / /_/ / /  / /_/ / /_/ / /  __/_____/ /_/ / / /_/ / /_/ / / / / /
        \__, /_/   \__,_/\__,_/_/\___/     / .___/_/\__,_/\__, /_/_/ /_/ 
       /____/                             /_/            /____/          

Usage

Add plugin, set font and caption in your build.gradle:

springBanner {
    font = 'soft'
    caption = """Version: \${application.version:${project.version}}
Description: \${application.description:${project.description}}"""
}

In caption use \${application.version} for values from Spring and ${project.version} for values from Gradle.

Configuration

Configure in your build.gradle:

springBanner {
    text = 'Your text for banner' // default - project.name
    separator = '\n' // default - system.lineSeparator
    caption = 'Your text under the banner' // default - 'Powered by Spring Boot v\${spring-boot.version}'
    font = 'Some font' // default - 'standard'
}

Tasks

Spring banner tasks
-------------------
generateBanner - Generates 'banner.txt'.
showAllBannerFonts - Displays all Spring banner fonts.
showAllBanners - Displays all Spring banners.
showBanner - Displays Spring banner.

Alternatives

License

This project is licensed under Apache License, version 2.0.