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!: Change configuration and devices files format to YAML #445

Merged
merged 5 commits into from
Mar 28, 2023

Conversation

vli11
Copy link
Contributor

@vli11 vli11 commented Mar 24, 2023

BREAKING CHANGE: Configuration and devices files are now in YAML format

closes issue #444

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/device-modbus-go/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?)
  • 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

device-modbus-go$ make tidy
device-modbus-go$ make build
device-modbus-go$ make test
device-modbus-go$ make docker
edgex-compose$ make pull
edgex-compose/compose-builder$ make run no-secty
device-modbus-go/cmd$ ./device-modbus -cp -o
verified that device-modbus-go log has below printout without error

level=INFO ts=2023-03-24T17:24:41.646708706Z app=device-modbus source=config.go:530 msg="Loaded private configuration from ./res/configuration.yaml"
...
level=INFO ts=2023-03-24T17:24:41.706087703Z app=device-modbus source=devices.go:51 msg="Loading pre-defined devices from /home/v/source/repos/device-modbus-go/cmd(3 files found)"

New Dependency Instructions (If applicable)

Comment on lines 12 to 15
Service:
Port: 59901
StartupMsg: device modbus started
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Service:
Port: 59901
StartupMsg: device modbus started
Service:
Host: localhost
Port: 59901
StartupMsg: device modbus started

@@ -0,0 +1,56 @@
# Pre-define Devices
DeviceList:
Copy link
Member

Choose a reason for hiding this comment

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

Same issue here as in the other PR about fields needing to be camelCase.

vli11 added 4 commits March 28, 2023 12:10
BREAKING CHANGE: Configuration and devices files are now in YAML format

closes issue edgexfoundry#444

Signed-off-by: Valina Li <valina.li@intel.com>
Signed-off-by: Valina Li <valina.li@intel.com>
Signed-off-by: Valina Li <valina.li@intel.com>
Signed-off-by: Valina Li <valina.li@intel.com>
@codecov-commenter
Copy link

codecov-commenter commented Mar 28, 2023

Codecov Report

Merging #445 (325a873) into main (63f56b4) will not change coverage.
The diff coverage is n/a.

📣 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     #445   +/-   ##
=======================================
  Coverage   42.52%   42.52%           
=======================================
  Files           6        6           
  Lines         555      555           
=======================================
  Hits          236      236           
  Misses        276      276           
  Partials       43       43           

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

Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

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

Still need to remove TOML modules from Attribution.txt

Signed-off-by: Valina Li <valina.li@intel.com>
@vli11 vli11 requested a review from lenny-goodell March 28, 2023 20:16
Copy link
Member

@lenny-goodell lenny-goodell 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 053db68 into edgexfoundry:main Mar 28, 2023
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.

3 participants