[skip-changelog] Correct profile dependency version constraint format in demo sketch project file #2590
+2
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… in demo sketch project file
The Sketch Project File documentation includes a demonstration of a complete project file.
Sketch project files use Arduino CLI's `<dependency ID> (<constraint>)` version constraint format but previously an
unsupported `<dependency ID>@<version>` format was used in some of the dependencies specified in the demonstration
project file. This would cause a panic if used in a project file:
panic: profiles parsing err: invalid 'platform' directive
goroutine 1 [running]:
github.com/arduino/arduino-cli/arduino/sketch.(*projectRaw).getProfiles(0xc0003f2000)
E:/git/arduino/arduino-cli/arduino/sketch/profiles.go:84 +0x1fe
github.com/arduino/arduino-cli/arduino/sketch.LoadProjectFile(0xc0002fac40?)
E:/git/arduino/arduino-cli/arduino/sketch/profiles.go:265 +0xb6
github.com/arduino/arduino-cli/arduino/sketch.New(0xc00022d6c0?)
E:/git/arduino/arduino-cli/arduino/sketch/sketch.go:90 +0x587
github.com/arduino/arduino-cli/commands/sketch.LoadSketch({0xc000150060?, 0xc000000004?}, 0xc00022d9b8?)
E:/git/arduino/arduino-cli/commands/sketch/load.go:30 +0x58
github.com/arduino/arduino-cli/internal/cli/compile.runCompileCommand(0xc0003aa000?, {0xc0003029c0, 0x1, 0x15c1559?})
E:/git/arduino/arduino-cli/internal/cli/compile/compile.go:162 +0x1dc
github.com/spf13/cobra.(*Command).execute(0xc0003aa000, {0xc000302990, 0x1, 0x1})
C:/Users/per/go/pkg/mod/github.com/spf13/cobra@v1.7.0/command.go:944 +0x863
github.com/spf13/cobra.(*Command).ExecuteC(0xc00019e300)
C:/Users/per/go/pkg/mod/github.com/spf13/cobra@v1.7.0/command.go:1068 +0x3a5
github.com/spf13/cobra.(*Command).Execute(0x0?)
C:/Users/per/go/pkg/mod/github.com/spf13/cobra@v1.7.0/command.go:992 +0x13
main.main()
E:/git/arduino/arduino-cli/main.go:31 +0xda
per1234
added
topic: documentation
alessio-perugini
approved these changes
May 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
Docs fix
What is the current behavior?
The sketch project file documentation includes a demonstration of a complete project file.
Sketch project files use Arduino CLI's
<dependency ID> (<constraint>)version constraint format but previously an unsupported<dependency ID>@<version>format was used in some of the dependencies specified in the demonstration project file. This causes a panic if used in a project file:What is the new behavior?
Use valid version constraint format in demonstration sketch project file.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.