Skip to content

[breaking] Change gRPC DebugConfigRequest port field type #1414

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

Merged
merged 1 commit into from
Aug 26, 2021

Conversation

silvanocerza
Copy link
Contributor

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Changes gRPC request field type.

  • What is the current behavior?

DebugConfigRequest port field has type string.

  • What is the new behavior?

DebugConfigRequest port field has now type Port.

// Port represents a board port that may be used to upload or to monitor a board
message Port {
  // Address of the port (e.g., `/dev/ttyACM0`).
  string address = 1;
  // The port label to show on the GUI (e.g. "ttyACM0")
  string label = 2;
  // Protocol of the port (e.g., `serial`, `network`, ...).
  string protocol = 3;
  // A human friendly description of the protocol (e.g., "Serial Port (USB)"
  string protocol_label = 4;
  // A set of properties of the port
  map<string, string> properties = 5;
}```

- **Does this PR introduce a breaking change, and is
[titled accordingly](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking)?**

Yes and yes.

* **Other information**:

None.

---

See [how to contribute](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/)

@silvanocerza silvanocerza requested a review from cmaglie August 25, 2021 14:17
@silvanocerza silvanocerza self-assigned this Aug 25, 2021
@silvanocerza silvanocerza force-pushed the scerza/debug-grpc-request-change branch from 4b2ec86 to 243feb4 Compare August 25, 2021 14:30
@silvanocerza silvanocerza force-pushed the scerza/debug-grpc-request-change branch from 243feb4 to 4e1babe Compare August 25, 2021 15:21
@silvanocerza silvanocerza merged commit a07258b into master Aug 26, 2021
@silvanocerza silvanocerza deleted the scerza/debug-grpc-request-change branch August 26, 2021 07:50
@rsora rsora added the topic: gRPC Related to the gRPC interface label Sep 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: gRPC Related to the gRPC interface type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants