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

refactor!: Switch to loading configuation files as YAML #484

Merged
merged 1 commit into from
Mar 16, 2023

Conversation

lenny-goodell
Copy link
Member

BREAKING CHANGE: All configruation file must now be in YAML format. The default file name has changed to be configuration.yaml

closes #424

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/go-mod-bootstrap/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
  • I am not introducing a new dependency (add notes below if you are)
  • I have added unit tests for the new feature or bug fix (if not, why?) existing suffice
  • I have fully tested (add details below) this the new feature or bug fix (if not, why?)
  • I have opened a PR for the related docs change (if not, why?)

Testing Instructions

run non-secure EdgeX stack
Stope core data and remove core data config from Consul
Build core data with this branch
Convert core data config to YAML
Run core data from command line with just -cp
Verify core data config loaded and pushed to consul

New Dependency Instructions (If applicable)

BREAKING CHANGE: All configruation file must now be in YAML format. The default file name has changed to be configuration.yaml

closes edgexfoundry#424

Signed-off-by: Leonard Goodell <[email protected]>
@codecov-commenter
Copy link

Codecov Report

Merging #484 (c3808ad) into main (99b3ee9) will decrease coverage by 0.17%.
The diff coverage is 0.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main     #484      +/-   ##
==========================================
- Coverage   57.26%   57.10%   -0.17%     
==========================================
  Files          26       26              
  Lines        2043     2049       +6     
==========================================
  Hits         1170     1170              
- Misses        801      807       +6     
  Partials       72       72              
Impacted Files Coverage Δ
bootstrap/config/config.go 30.38% <0.00%> (-0.34%) ⬇️
bootstrap/flags/flags.go 61.90% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Contributor

@jim-wang-intel jim-wang-intel left a comment

Choose a reason for hiding this comment

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

LGTM

@cloudxxx8
Copy link
Member

Why do we still return a TOML Tree?
Should we remove the TOML dependency?

@lenny-goodell
Copy link
Member Author

lenny-goodell commented Mar 16, 2023

Why do we still return a TOML Tree? Should we remove the TOML dependency?

Because we are still dependent on it for overrides and pushing config to Confg Provider. YAML doesn't have corresponding feature. Plan it to refactor it out later when we have more time.

Copy link
Member

@cloudxxx8 cloudxxx8 left a comment

Choose a reason for hiding this comment

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

LGTM

@lenny-goodell lenny-goodell merged commit 9d98d1e into edgexfoundry:main Mar 16, 2023
@lenny-goodell lenny-goodell deleted the yaml branch March 16, 2023 14:26
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

Successfully merging this pull request may close these issues.

Change configuration file format to be YAML
4 participants