Skip to content

Commit

Permalink
Preparing docs for 1.0.0-rc.1 relese
Browse files Browse the repository at this point in the history
  • Loading branch information
cmaglie committed Jan 10, 2024
1 parent 2972ed8 commit 5869b67
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 16 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand All @@ -33,9 +30,9 @@ contribute your changes to the project.

:sparkles: Thanks to all our [contributors]! :sparkles:

### Beta testing
### Testing builds

[Nightly builds] are available for beta testing.
[Nightly builds] are available for testing.

## Security

Expand Down
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ There are several ways you can get involved:
| ------------------------------------------------- | ------------------------------------------------------- |
| - Support request<br/>- Question<br/>- Discussion | Post on the [Arduino Forum][forum] |
| - Bug report<br/>- Feature request | Issue report (read the [issue guidelines][issues]) |
| Beta testing | Try out the [nightly build][nightly] |
| Testing | Try out the [nightly build][nightly] |
| - Bug fix<br/>- Enhancement | Pull Request (read the [pull request guidelines][prs]) |
| Translations for Arduino CLI | [transifex][translate] |
| Translations for Arduino CLI | Use the [transifex][translate] platform |
| Monetary | - [Donate][donate]<br/>- [Buy official products][store] |

## Issue Reports
Expand Down
2 changes: 1 addition & 1 deletion docs/UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-rc.0

### The gRPC `cc.arduino.cli.commands.v1.LoadSketchResponse` message has been changed.

Expand Down
4 changes: 0 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,6 @@ in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the
[macos64]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_macOS_64bit.tar.gz
[macosarm64]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_macOS_ARM64.tar.gz

> **Deprecation notice**: links in the form
> `http://downloads.arduino.cc/arduino-cli/arduino-cli-latest-<platform>.tar.bz2` won’t be further updated. That URL
> will provide the version `0.3.7-alpha.preview`, regardless of further releases.
### Previous versions

These are available from the "Assets" sections on the [releases page](https://github.com/arduino/arduino-cli/releases).
Expand Down
9 changes: 5 additions & 4 deletions docs/versioning.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# 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 after the release of version 1.0.0. The project is currently in the production release-candidate phase,
the API is stable and only bug fixes releases are expected before 1.0.0.

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-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
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).
Expand Down

0 comments on commit 5869b67

Please sign in to comment.