Skip to content

[proposal] Release the proto files with the CLI #588

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

Closed
kittaakos opened this issue Feb 19, 2020 · 4 comments · Fixed by #1931
Closed

[proposal] Release the proto files with the CLI #588

kittaakos opened this issue Feb 19, 2020 · 4 comments · Fixed by #1931
Assignees
Labels
conclusion: resolved Issue was resolved topic: gRPC Related to the gRPC interface topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement

Comments

@kittaakos
Copy link
Contributor

Proposal

Current behavior

As a gRPC consumer of the CLI, I have to generate the JS/TS modules from the proto files. It would be nice to ship the releases with the proto files so that one can make sure the CLI is compatible with the gRPC API.

As a possible workaround for this limitation:

  • one can download the CLI,
  • run ./arduino-cli version,
  • parse the output:
./arduino-cli version
arduino-cli Version: 0.8.0 Commit: 64c501d
  • clone arduino/arduino-cli and checkout the 64c501d commit,
  • run the TS/JS generation from the proto files

Expected behavior

Environment

  • CLI version (output of arduino-cli version):
  • OS and platform:

Additional context

@rsora rsora added component/gRPC type: enhancement Proposed improvement labels Feb 20, 2020
@per1234 per1234 reopened this Mar 30, 2021
@rsora rsora added the topic: gRPC Related to the gRPC interface label Sep 22, 2021
@per1234 per1234 self-assigned this Mar 3, 2022
@per1234 per1234 added the topic: infrastructure Related to project infrastructure label Mar 3, 2022
@umbynos
Copy link
Contributor

umbynos commented Oct 13, 2022

Hi @kittaakos, is this something that is still needed?
I would not add more complexity in our released archives, maybe a workaround would be to just add a new archive to the releases including only the proto files. But at this point you have the same result as git cloning the repo and checking out the release tag.

@umbynos umbynos added the status: waiting for information More information must be provided before work can proceed label Oct 13, 2022
@kittaakos
Copy link
Contributor Author

maybe a workaround would be to just add a new archive to the releases including only the proto files

Sounds great.

But at this point you have the same result as git cloning the repo and checking out the release tag.

How do you expect anybody to develop against the CLI when the APIs are unavailable as part of the release? It's not only for IDE2 but for the public. In fact, IDE2 has to build the CLI quite often from a branch, so distributing the .proto files is not a silver-bullet solution.

@kittaakos kittaakos removed the status: waiting for information More information must be provided before work can proceed label Oct 17, 2022
@umbynos umbynos added this to the Arduino CLI 1.0 milestone Oct 18, 2022
@umbynos
Copy link
Contributor

umbynos commented Oct 18, 2022

We will make a special archive called arduino-cli_0.27.1_proto.zip and add it to the release files. The files that will be added to the archive will be these ones filtering out the .go ones. Would that be good for you?

@kittaakos
Copy link
Contributor Author

Fantastic! 😍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: gRPC Related to the gRPC interface topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
6 participants