From 5869b67e2799c9cde143238523cd65d1880af321 Mon Sep 17 00:00:00 2001 From: Cristian Maglie Date: Thu, 4 Jan 2024 18:09:47 +0100 Subject: [PATCH 1/3] Preparing docs for 1.0.0-rc.1 relese --- README.md | 7 ++----- docs/CONTRIBUTING.md | 4 ++-- docs/UPGRADING.md | 2 +- docs/installation.md | 4 ---- docs/versioning.md | 9 +++++---- 5 files changed, 10 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 39ecae5f037..18633011a45 100644 --- a/README.md +++ b/README.md @@ -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]. @@ -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 diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d21314c52c5..743c01efe39 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -8,9 +8,9 @@ There are several ways you can get involved: | ------------------------------------------------- | ------------------------------------------------------- | | - Support request
- Question
- Discussion | Post on the [Arduino Forum][forum] | | - Bug report
- 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
- 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]
- [Buy official products][store] | ## Issue Reports diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index 31b7807362a..789a9255b6d 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -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. diff --git a/docs/installation.md b/docs/installation.md index b5499ee6ce9..06cc18a9102 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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-.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). diff --git a/docs/versioning.md b/docs/versioning.md index ef8977300ba..98a7356d0c9 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -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). From 264953d7897ffa80a3b2a51ff0896cd7cc503e90 Mon Sep 17 00:00:00 2001 From: Cristian Maglie Date: Thu, 11 Jan 2024 10:46:39 +0100 Subject: [PATCH 2/3] Update docs/UPGRADING.md Co-authored-by: Umberto Baldi <34278123+umbynos@users.noreply.github.com> --- docs/UPGRADING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index 789a9255b6d..7fab0acd986 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -2,7 +2,7 @@ Here you can find a list of migration guides to handle breaking changes between releases of the CLI. -## 1.0.0-rc.0 +## 1.0.0-rc.1 ### The gRPC `cc.arduino.cli.commands.v1.LoadSketchResponse` message has been changed. From 8670d8cf58abbeb484932cd02a741ae6dda9f239 Mon Sep 17 00:00:00 2001 From: Umberto Baldi Date: Thu, 11 Jan 2024 12:10:49 +0100 Subject: [PATCH 3/3] revert, we are releasing 0.36.0 --- README.md | 3 +++ docs/UPGRADING.md | 2 +- docs/versioning.md | 9 ++++----- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 18633011a45..a8d93cb2513 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,9 @@ 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]. diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index 7fab0acd986..31b7807362a 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -2,7 +2,7 @@ Here you can find a list of migration guides to handle breaking changes between releases of the CLI. -## 1.0.0-rc.1 +## 0.36.0 ### The gRPC `cc.arduino.cli.commands.v1.LoadSketchResponse` message has been changed. diff --git a/docs/versioning.md b/docs/versioning.md index 98a7356d0c9..ef8977300ba 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -1,18 +1,17 @@ # 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 production release-candidate phase, -the API is stable and only bug fixes releases are expected before 1.0.0. +minor releases after the release of version 1.0.0. The project is currently in the last period of the Beta phase. 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).