Skip to content

Fix readme notice about CLI versioning #2892

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix readme notice about CLI versioning #2892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51d882b
Fix readme notice about CLI versioning
cmaglie Apr 18, 2025
8b96c33
Rename variable
cmaglie Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ services and messages are detailed in the [gRPC reference] pages.

## Versioning and backward compatibility policy

This software is currently under active development: anything can change at any time, API and UI must be considered
unstable until we release version 1.0.0. For more information see our [versioning and backward compatibility] policy.
The Arduino CLI is in the stable production release 1.x.x. All API (JSON and gRPC) stable, any possible new breaking
change will be delayed until the next major release. For more information see our [versioning and backward
compatibility] policy.

[installation]: installation.md
[getting started guide]: getting-started.md
Expand Down
6 changes: 3 additions & 3 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func main() {

// Read the settings from the configuration file
openReq := &rpc.ConfigurationOpenRequest{SettingsFormat: "yaml"}
var configFileLoadingWarnings []string
var configFileWarnings []string
if configData, err := paths.New(configFile).ReadFile(); err == nil {
openReq.EncodedSettings = string(configData)
} else if !os.IsNotExist(err) {
Expand All @@ -57,7 +57,7 @@ func main() {
feedback.FatalError(fmt.Errorf("couldn't load configuration: %w", err), feedback.ErrGeneric)
} else if warnings := resp.GetWarnings(); len(warnings) > 0 {
// Save the warnings to show them later when the feedback package is fully initialized
configFileLoadingWarnings = warnings
configFileWarnings = warnings
}

// Get the current settings from the server
Expand All @@ -82,7 +82,7 @@ func main() {
// only if we are inside the "config ..." command. In JSON mode always
// output the warning.
if feedback.GetFormat() != feedback.Text || (cmd.HasParent() && cmd.Parent().Name() == "config") {
for _, warning := range configFileLoadingWarnings {
for _, warning := range configFileWarnings {
feedback.Warning(fmt.Sprintf("%s: %s", i18n.Tr("Invalid value in configuration"), warning))
}
}
Expand Down
Loading