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

[breaking] Implementation of sketch profiles #1713

Merged
merged 35 commits into from
May 24, 2022
Merged

Conversation

cmaglie
Copy link
Member

@cmaglie cmaglie commented Apr 15, 2022

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?
This PR implements Profiles.
In the long run, profiles will eventually replace and deprecate sketch.json.

Does this PR introduce a breaking change, and is titled accordingly?
This PR introduces breaking changes in the golang API and the cli behavior.

@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Apr 15, 2022
@cmaglie cmaglie force-pushed the profiles branch 5 times, most recently from fe3ed29 to 5e3a93f Compare May 2, 2022 16:54
arduino/errors.go Outdated Show resolved Hide resolved
arduino/sketch/profiles.go Outdated Show resolved Hide resolved
cli/instance/instance.go Outdated Show resolved Hide resolved
rpc/cc/arduino/cli/commands/v1/commands.proto Outdated Show resolved Hide resolved
rpc/cc/arduino/cli/commands/v1/commands.proto Outdated Show resolved Hide resolved
arduino/sketch/sketch.go Show resolved Hide resolved
commands/instances.go Show resolved Hide resolved
arduino/sketch/profiles.go Outdated Show resolved Hide resolved
arduino/sketch/profiles.go Outdated Show resolved Hide resolved
cli/arguments/profiles.go Outdated Show resolved Hide resolved
@cmaglie cmaglie force-pushed the profiles branch 2 times, most recently from 544b0aa to 7dd09e7 Compare May 10, 2022 15:48
docs/sketch-profiles.md Outdated Show resolved Hide resolved
docs/sketch-profiles.md Outdated Show resolved Hide resolved
docs/sketch-profiles.md Outdated Show resolved Hide resolved
arduino/cores/packagemanager/profiles.go Outdated Show resolved Hide resolved
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

sketch-profiles.md should be added to the nav[] key in /mkdocs.yml so that the page is listed in the navigation panel of the documentation website. I recommend placing it after the "Sketch Specification" page:

- sketch-specification.md

@cmaglie
Copy link
Member Author

cmaglie commented May 19, 2022

sketch-profiles.md should be added to the nav[] key in /mkdocs.yml so that the page is listed in the navigation panel of the documentation website. I recommend placing it after the "Sketch Specification" page:

I've also renamed sketch-profiles.md in sketch-project-file.md, since the sketch.yaml will be surely extended in the future to support more features.

@cmaglie cmaglie self-assigned this May 19, 2022
@cmaglie cmaglie marked this pull request as ready for review May 19, 2022 12:23
arduino/sketch/profiles.go Show resolved Hide resolved
arduino/sketch/profiles.go Outdated Show resolved Hide resolved
docs/sketch-project-file.md Show resolved Hide resolved
docs/sketch-project-file.md Outdated Show resolved Hide resolved
docs/sketch-specification.md Outdated Show resolved Hide resolved
docs/sketch-project-file.md Outdated Show resolved Hide resolved
docs/sketch-specification.md Outdated Show resolved Hide resolved
docs/sketch-project-file.md Outdated Show resolved Hide resolved
docs/sketch-specification.md Outdated Show resolved Hide resolved
@cmaglie cmaglie force-pushed the profiles branch 2 times, most recently from c796fa4 to 5bd294f Compare May 20, 2022 07:59
docs/sketch-project-file.md Outdated Show resolved Hide resolved
docs/sketch-specification.md Outdated Show resolved Hide resolved
arduino/sketch/profiles.go Outdated Show resolved Hide resolved
arduino/sketch/sketch.go Outdated Show resolved Hide resolved
docs/sketch-specification.md Outdated Show resolved Hide resolved
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

Thanks @cmaglie and to the other contributors for this valuable advancement for the Arduino project.

The failing link check for https://www.arduino.cc/en/Reference/APIStyleGuide is unrelated to the changes made in this PR. I am monitoring that and will take action if needed to get the correct redirect set up.

cmaglie and others added 25 commits May 20, 2022 16:41
Makes it more future-proof in case of further expasion
Co-authored-by: per1234 <accounts@perglass.com>
Co-authored-by: per1234 <accounts@perglass.com>
Co-authored-by: per1234 <accounts@perglass.com>
Co-authored-by: per1234 <accounts@perglass.com>
@cmaglie
Copy link
Member Author

cmaglie commented May 20, 2022

Just rebased on master to fix the dead link, we should be all-green in a couple of minutes 🥳

@cmaglie cmaglie merged commit 7e9e4ca into arduino:master May 24, 2022
@cmaglie cmaglie deleted the profiles branch May 24, 2022 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants