Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
A
arduino-cli
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Operations
Operations
Metrics
Analytics
Analytics
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Commits
Open sidebar
xpstem
arduino-cli
Commits
827d5f84
Unverified
Commit
827d5f84
authored
May 17, 2024
by
Cristian Maglie
Committed by
GitHub
May 17, 2024
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[skip-changelog] Preparing docs for 1.0.0 release (#2553)
parent
b0cc1a9c
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
7 additions
and
11 deletions
+7
-11
README.md
README.md
+0
-3
docs/UPGRADING.md
docs/UPGRADING.md
+1
-1
docs/getting-started.md
docs/getting-started.md
+1
-2
docs/versioning.md
docs/versioning.md
+5
-5
No files found.
README.md
View file @
827d5f84
...
...
@@ -10,9 +10,6 @@ and many other tools needed to use any Arduino compatible board and platform fro
[
![Deploy Website status
](
https://github.com/arduino/arduino-cli/actions/workflows/deploy-cobra-mkdocs-versioned-poetry.yml/badge.svg
)
](https://github.com/arduino/arduino-cli/actions/workflows/deploy-cobra-mkdocs-versioned-poetry.yml)
[
![Codecov
](
https://codecov.io/gh/arduino/arduino-cli/branch/master/graph/badge.svg
)
](https://codecov.io/gh/arduino/arduino-cli)
> **Note:** 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.
## Docs
For guidance on installation and development, see the [User documentation].
...
...
docs/UPGRADING.md
View file @
827d5f84
...
...
@@ -2,7 +2,7 @@
Here you can find a list of migration guides to handle breaking changes between releases of the CLI.
##
0.36
.0
##
1.0
.0
### Configuration file now supports only YAML format.
...
...
docs/getting-started.md
View file @
827d5f84
Despite the lack of feature parity at the moment, Arduino CLI provides many of the features you can find in the Arduino
IDE. Let's see some examples.
Arduino CLI provides all the features you can find in the Arduino IDE. Let's see some examples.
## Before you start
...
...
docs/versioning.md
View file @
827d5f84
# Backward compatibility policy for arduino-cli.
The arduino-cli project follows a strict semantic versioning policy. We are committing not to make breaking changes in
minor releases
after the release of version 1.0.0. The project is currently in the last period of the Beta phase
.
minor releases
of Arduino CLI 1.x.x
.
The release rules are the following:
-
Alpha phase
`0.0.X`
: In this phase, the software is going through a quick iteration of the API, each release (with
increments of X) may contain massive and breaking changes.
-
**Beta phase `0.Y.X`**
: The software is usable, but the API is still not settled and is under continuous testing and
-
Beta phase
`0.Y.X`
: The software is usable, but the API is still not settled and is under continuous testing and
review. Breaking changes are expected. Bug fixes and new features are made as patch releases (with increments of X).
Breaking changes due to API refinements are made as minor releases (with increments of Y).
-
Production release-candidate
`1.0.0-rc.X`
: in this phase, the software is considered ready for release and distributed
to the users for final testing. Release candidates (with increments of X) are possible for bug fixes only.
-
Production release
`1.Y.X`
: For the production releases backward compatibility is guaranteed, and all the breaking
-
**Production release `1.Y.X`**
: For the production releases backward compatibility is guaranteed, and all the breaking
changes are cumulated for the next major release (2.0.0). Bug fixes are made as patch releases (with increments of X);
New features are released as minor releases (with increments of Y).
-
Next major release development
`2.0.0`
and up: see below.
-
Next major release development
`
>=
2.0.0`
and up: see below.
## Backward compatibility guarantees and definition of "breaking change"
...
...
@@ -36,7 +36,7 @@ Changes in the command-line interface are considered breaking if:
-
an optional positional argument or a flag is made mandatory
-
a positional argument or a flag format is changed
The following changes to the command-line syntax are NOT considered breaking:
The following changes to the command-line syntax are NOT considered breaking
changes
:
-
a new command is added
-
a new optional positional argument is added
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment