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] Check cross-platform compatibility of sketch names #2216

Merged

Conversation

MatteoPologruto
Copy link
Contributor

@MatteoPologruto MatteoPologruto commented Jun 14, 2023

Please check if the PR fulfills these requirements

See how to contribute

  • 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)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Documentation enhancement

What is the current behavior?

Sketch names ending with a . can be used. Reserved names can be used as sketch names.

What is the new behavior?

It is no longer possible to name sketches in the above mentioned way.

Does this PR introduce a breaking change, and is titled accordingly?

Yes

@MatteoPologruto MatteoPologruto added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Jun 14, 2023
@MatteoPologruto MatteoPologruto self-assigned this Jun 14, 2023
@MatteoPologruto MatteoPologruto linked an issue Jun 14, 2023 that may be closed by this pull request
3 tasks
@codecov
Copy link

codecov bot commented Jun 14, 2023

Codecov Report

Patch coverage: 46.22% and project coverage change: +0.15 🎉

Comparison is base (82e6f5d) 62.90% compared to head (a2aab05) 63.06%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2216      +/-   ##
==========================================
+ Coverage   62.90%   63.06%   +0.15%     
==========================================
  Files         218      220       +2     
  Lines       19452    19481      +29     
==========================================
+ Hits        12237    12285      +48     
+ Misses       6134     6116      -18     
+ Partials     1081     1080       -1     
Flag Coverage Δ
unit 63.06% <46.22%> (+0.15%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
arduino/errors.go 27.62% <0.00%> (-0.40%) ⬇️
commands/daemon/daemon.go 28.70% <0.00%> (-0.27%) ⬇️
commands/instances.go 64.70% <ø> (+3.73%) ⬆️
commands/sketch/set_defaults.go 0.00% <0.00%> (ø)
internal/cli/arguments/sketch.go 85.00% <ø> (-3.47%) ⬇️
internal/cli/board/attach.go 25.42% <0.00%> (+2.69%) ⬆️
internal/cli/burnbootloader/burnbootloader.go 45.23% <0.00%> (ø)
internal/cli/monitor/monitor.go 13.07% <0.00%> (ø)
internal/cli/arguments/port.go 46.87% <20.00%> (-4.15%) ⬇️
internal/cli/debug/debug.go 68.13% <40.00%> (-2.33%) ⬇️
... and 5 more

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

docs/sketch-specification.md Outdated Show resolved Hide resolved
@per1234 per1234 added the topic: code Related to content of the project itself label Jun 14, 2023
commands/sketch/new.go Outdated Show resolved Hide resolved
@per1234 per1234 dismissed their stale review June 19, 2023 08:39

Requested changes made. Thanks!

@MatteoPologruto MatteoPologruto merged commit a71415f into arduino:master Jun 20, 2023
91 checks passed
@MatteoPologruto MatteoPologruto deleted the cross-platform-sketch-name branch June 20, 2023 06:38
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 topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Require cross-platform compatibility of sketch names in specification
4 participants