Skip to content

"Customizing the Banner" should make it more obvious that any environment property can be used #29920

@snicoll

Description

@snicoll

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

If you have contributed before, consider leaving this one for someone new, and looking through our general ideal-for-contribution issues. Thanks!

Problem

This section in the reference documentation lists a number of variables that can be used in a custom banner.txt, but not mention that any property in the Environment could be used as well.

Solution

An edit to the reference documentation should be made to mention the use of any key of the Environment. The file to update is located in spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/spring-application.adoc. There is the following sentences:

Inside your banner.txt file, you can use any of the following placeholders:

That can be edited to looks like the following:

Inside your banner.txt file, you can use any key available in the Environment as well as any of the following placeholders:

Steps to Fix

  • Claim this issue with a comment below and ask any clarifying questions you need
  • Set up a repository locally following the Contributing Guidelines
  • Try to fix the issue following the steps above
  • Commit your changes and start a pull request.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions