Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate section related to configuration parameters of Record Manager #80

Open
blcham opened this issue Nov 6, 2024 · 1 comment
Open
Assignees

Comments

@blcham
Copy link

blcham commented Nov 6, 2024

As a developer, I would like a section visible from README.md showing all the backend configuration parameters. Those parameters should be generated from Spring annotations related to configuration. There is an annotation processor plugin that can be used for this purpose.

It should be done similarly to https://github.com/kbss-cvut/termit-docker?tab=readme-ov-file#further-termit-configuration. It is generated by an annotation processor (see example in https://github.com/kbss-cvut/termit/blob/22ffaed4a221679b2598aef0b11420243a27f123/pom.xml#L427), while generated values are taken from spring annotations
@Value or @ConfigurationProperties (see example in https://github.com/kbss-cvut/termit/blob/master/src/main/java/cz/cvut/kbss/termit/util/Configuration.java)

A/C:

  • configuration parameters are generated with build into .md file
  • The .md file is included/referenced in README.md
  • It is considered if it is useful to reference this .md file in record-manager-ui
@blcham
Copy link
Author

blcham commented Nov 7, 2024

@palagdan I guess the issue here is again that we are using @PropertySource, instead @ConfigurationProperties+@EnableConfigurationProperties which stopped us using application.yml in PR -- #76 (comment).

Now, we need it again so the annotation processor can process it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants