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!: Changed configuration and simple-devices files format to YAML #281

Merged
merged 2 commits into from
Mar 28, 2023

Conversation

vli11
Copy link
Contributor

@vli11 vli11 commented Mar 24, 2023

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

closes issue #280

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/device-rest-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-rest-go$ make clean
/device-rest-go$ make build
/device-rest-go$ make docker
/device-rest-go$ make test without error
edgex-compose/compose-builder$ make pull
edgex-compose/compose-builder$ make run no-secty
device-rest-go/cmd$ ./device-rest -cp -o
verify that below message in the log without error:

level=INFO ts=2023-03-28T18:45:53.995919449Z app=device-rest source=config.go:565 msg="Loading configuration file from ./res/configuration.yaml"
...
level=INFO ts=2023-03-28T18:45:54.077009243Z app=device-rest source=devices.go:51 msg="Loading pre-defined devices from /home/v/source/repos/device-rest-go/cmd/res/devices(1 files found)"
level=INFO ts=2023-03-28T18:45:54.077807678Z app=device-rest source=devices.go:92 msg="Device sample-json not found in Metadata, adding it ..."
level=INFO ts=2023-03-28T18:45:54.077914571Z app=device-rest source=devices.go:92 msg="Device sample-image not found in Metadata, adding it ..."
level=INFO ts=2023-03-28T18:45:54.077963557Z app=device-rest source=devices.go:92 msg="Device sample-numeric not found in Metadata, adding it ..."
level=INFO ts=2023-03-28T18:45:54.078002496Z app=device-rest source=devices.go:92 msg="Device 2way-rest-device not found in Metadata, adding it ..."

New Dependency Instructions (If applicable)

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

closes issue edgexfoundry#280

Signed-off-by: Valina Li <[email protected]>
@vli11 vli11 marked this pull request as draft March 24, 2023 00:25
README.md Outdated Show resolved Hide resolved
cmd/res/configuration.yaml Outdated Show resolved Hide resolved
cmd/res/configuration.yaml Outdated Show resolved Hide resolved
cmd/res/configuration.yaml Outdated Show resolved Hide resolved
cmd/res/devices/sample-devices.yaml Outdated Show resolved Hide resolved
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 marked this pull request as ready for review March 28, 2023 19:46
@lenny-goodell lenny-goodell merged commit fdf83ba into edgexfoundry:main Mar 28, 2023
@lenny-goodell lenny-goodell linked an issue Mar 28, 2023 that may be closed by this pull request
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 and simple-devices files format to YAML
2 participants