Skip to content

Add support for YAML configuration file format#1682

Closed
YangSiJun528 wants to merge 17 commits intospring-io:mainfrom
YangSiJun528:yaml-support
Closed

Add support for YAML configuration file format#1682
YangSiJun528 wants to merge 17 commits intospring-io:mainfrom
YangSiJun528:yaml-support

Conversation

@YangSiJun528
Copy link
Copy Markdown
Contributor

@YangSiJun528 YangSiJun528 commented Jul 31, 2025 •
edited
Loading

This PR adds an option to generate project configuration in YAML format. Currently, only .properties is supported. (#1109)

This PR has many changes, so I'm opening this PR early to get feedback before completing all implementation details. The core features work well, but I still need to add more comprehensive tests - currently only basic tests are implemented.

Main Changes

  • Add ConfigurationFileFormat interface with factory and implementations for Properties and YAML
  • Update ApplicationProperties to write YAML format
  • Add ApplicationYamlPropertiesContributor
  • Add @ConditionalOnConfigurationFileFormat and OnConfigurationFileFormatCondition to choose between Properties and YAML
  • Add config file format support to MutableProjectDescription, InitializrMetadata, and ProjectRequest
  • Update tests: since configuration file format is now configurable, remove application.properties validation or set format explicitly where needed.

Need Feedback On

  • Is the name and package location of ConfigurationFileFormat appropriate? (io.spring.initializr.generator.configuration.format)
  • Any feedback on the overall design?
  • Are there any missing features or edge cases to consider?

Once I receive feedback on the approach, I will add comprehensive tests and polish the implementation before requesting final review.

Fixes gh-1109

@YangSiJun528
Add factory for configuration file format selection
7e2c994 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Add configuration file format to ProjectDescription
0fdb1c0 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Introduce conditional configuration file format support
b363f4f 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Add metadata about ConfigurationFileFormat
8d966a7 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Add ApplicationYamlPropertiesContributor
951ff1a 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Fix failed tests
c5a597f 
All tests passed up to the initializr-generator-spring module.

Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Add support for configuration file format to the initializr-web module
b8196b0 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Add support for configuration file format to the initializr-actuator …
6cd153c 
…module

Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Implement writeYaml
cd2a07f 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Rename id of YamlFormat
91c2853 
Signed-off-by: sijun-yang <[email protected]>
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jul 31, 2025
@YangSiJun528 YangSiJun528 marked this pull request as ready for review August 4, 2025 04:46
@mhalbritter
Copy link
Copy Markdown
Contributor

mhalbritter commented Aug 4, 2025

Thanks @YangSiJun528, I'm going to take a look. I'm in the middle of something right now, but i plan to look at it this week.

@mhalbritter mhalbritter self-assigned this Aug 8, 2025
mhalbritter
mhalbritter reviewed Aug 8, 2025
View reviewed changes
Comment thread ...st/java/io/spring/initializr/web/controller/ProjectGenerationControllerIntegrationTests.java Outdated
Comment thread initializr-web/src/test/resources/metadata/test-default-2.0.0-ssl.json Outdated
}
]
},
"configurationFileFormat": {
Copy link
Copy Markdown
Contributor

@mhalbritter mhalbritter Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the metadata v2.0.0 format. I think we should add a new metadata version v2.3 which adds the configurationFileFormat field. You can take a look at InitializrMetadataV22JsonMapper and InitializrMetadataV21JsonMapper for that.

Copy link
Copy Markdown
Contributor Author

@YangSiJun528 YangSiJun528 Aug 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reverted the changes to InitializrMetadataV2JsonMapper and added InitializrMetadataV23JsonMapper.

@mhalbritter
Copy link
Copy Markdown
Contributor

mhalbritter commented Aug 8, 2025

Hi @YangSiJun528 ,

thanks for the PR. I've left some comments for your consideration.

I think your name ConfigurationFileFormat is a good one. Aside from the new metadata version the design looks sane, and I can't see any missing edge cases.

@mhalbritter mhalbritter added the status: waiting-for-feedback We need additional information before we can continue label Aug 8, 2025
@YangSiJun528
Fix too many & in url
3de162c 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Remove configurationFileFormat from metadata v2.x
661049d 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Add InitializrMetadataV23JsonMapper
3d93133 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Add support for v2.3 metadata endpoint
37d4d11 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
�Chore
8ee11a5 
Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Revert "�Chore"
c33b851 
This reverts commit 19c8659.

Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528
Copy link
Copy Markdown
Contributor Author

YangSiJun528 commented Aug 10, 2025 •
edited
Loading

Applied feedback to address metadata format compatibility issues.

configuration file format addition changes the metadata structure, requiring format versioning:

  • Revert InitializrMetadataV2JsonMapper to preserve v2.0 format
  • Create InitializrMetadataV23JsonMapper for new v2.3 format support
  • Add InitializrMetadataVersion.V2_3 enum value
  • Add v2.3 endpoints in ProjectMetadataController

This maintains v2.0 compatibility while enabling configuration file format features in v2.3.

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Aug 10, 2025
@YangSiJun528
Copy link
Copy Markdown
Contributor Author

YangSiJun528 commented Aug 12, 2025

And I have added compliance tests to ApplicationPropertiesComplianceTests.

This PR should now be ready for review. @mhalbritter

@mhalbritter mhalbritter changed the title Add YAML support for configuration file format Add support for YAML configuration file format Aug 14, 2025
@mhalbritter mhalbritter mentioned this pull request Aug 14, 2025
Closed
@mhalbritter mhalbritter added type: enhancement and removed status: feedback-provided Feedback has been provided status: waiting-for-triage An issue we've not yet triaged labels Aug 14, 2025
mhalbritter pushed a commit that referenced this pull request Aug 14, 2025
@YangSiJun528 @mhalbritter
Add support for YAML configuration file format
20f0907 
See gh-1682

Signed-off-by: sijun-yang <[email protected]>
mhalbritter added a commit that referenced this pull request Aug 14, 2025
@mhalbritter
Polish "Add support for YAML configuration file format"
de8d39c 
See gh-1682
@mhalbritter
Copy link
Copy Markdown
Contributor

mhalbritter commented Aug 14, 2025 •
edited
Loading

Thanks @YangSiJun528 !

I've polished a bit, for example the created file is now named application.yaml (i've added the a).

Users who upgrade to initializr 0.23.0 will have to update their application configuration, with something like this:

  configuration-file-formats:
    - name: Properties
      id: properties
      default: true
    - name: YAML
      id: yaml
      default: false

@mhalbritter mhalbritter added this to the 0.23.0 milestone Aug 14, 2025
@mhalbritter mhalbritter mentioned this pull request Aug 14, 2025
Closed
@YangSiJun528
Copy link
Copy Markdown
Contributor Author

YangSiJun528 commented Aug 14, 2025

Thanks for making this change!

I initially used .yml in this PR because Spring Initializr does, and in my experience, .yml is more common in Spring projects. Since the Spring Boot docs mix .yaml and .yml, I assumed .yml would be preferred.

After looking into it, I learned .yaml is officially recommended by the YAML spec, so I agree using .yaml makes sense.

Just leaving a note in case anyone wonders why .yml wasn’t used.

YangSiJun528 added a commit to YangSiJun528/initializr that referenced this pull request Aug 28, 2025
@YangSiJun528
Handle ConfigurationFileFormat in description copy and diff
0279eb1 
The ConfigurationFileFormat introduced in spring-iogh-1682 is not handled
in the MutableProjectDescription copy constructor or in
ProjectDescriptionDiff.

This commit adds the missing logic and corresponding tests.

Signed-off-by: sijun-yang <[email protected]>
YangSiJun528 added a commit to YangSiJun528/initializr that referenced this pull request Aug 28, 2025
@YangSiJun528
Handle ConfigurationFileFormat in description copy and diff
da6a033 
The ConfigurationFileFormat introduced in spring-iogh-1682 is not handled
in the MutableProjectDescription copy constructor or in
ProjectDescriptionDiff.

This commit adds the missing logic and corresponding tests.

Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528 YangSiJun528 mentioned this pull request Aug 28, 2025
Closed
mhalbritter pushed a commit that referenced this pull request Aug 28, 2025
@YangSiJun528 @mhalbritter
Handle ConfigurationFileFormat in description copy and diff
663cbdd 
The ConfigurationFileFormat introduced in gh-1682 is not handled
in the MutableProjectDescription copy constructor or in
ProjectDescriptionDiff.

This commit adds the missing logic and corresponding tests.

See gh-1693

Signed-off-by: sijun-yang <[email protected]>
@YangSiJun528 YangSiJun528 mentioned this pull request Sep 5, 2025
Closed
@mhalbritter mhalbritter mentioned this pull request Nov 18, 2025
Closed
@mhalbritter mhalbritter added the status: noteworthy A noteworthy issue to call out in the release notes label Nov 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mhalbritter mhalbritter mhalbritter left review comments

Assignees

@mhalbritter mhalbritter

Labels

status: noteworthy A noteworthy issue to call out in the release notes type: enhancement

Projects

None yet

Milestone

0.23.0

Development

Successfully merging this pull request may close these issues.

Add contribution model for application configuration

3 participants

@YangSiJun528 @mhalbritter @spring-projects-issues