GitLab

* Download gzipped version of the library index

* Check gpg signature for library_index.json

* Update docs/UPGRADING.md

* upgrade go-paths-helper to 1.6.0

* Fixed tests for new go-path library release

* Replace "Arduino Pro IDE" with proper link to Arduino IDE 2.0

* Run prettier

The library.properties `includes` field specifies a custom list of files to be added to the sketch by the IDE as
`#include` directives. Library authors sometimes add filenames from library dependencies to this field. However, that
doesn't make any sense because all Arduino development software versions with support for the `includes` field have also
had support for resolution of the dependencies of libraries, meaning that there is no need for these `#include`
directives to be placed in the sketch.

For this reason, Arduino Lint rule LP052 ("library.properties includes field item(s) not found in library.") was
configured as an error when the tool is in the default "specification" compliance mode. Since the required rules in this
mode are intended to match the official Arduino Library Specification, it is important that mention be made in the
`includes` field that it should contain files of the library itself.

Since this requirement is fairly common sense, and the format of the library.properties fields documentation somewhat
constraining, I attempted to document it with minimal verbosity.

* add gpg public key to verify board_index.json

* add new function to allow the usage of another gpg key

* add new test and enhance existing ones

* apply suggestions by @cmaglie

* move `module_firmware_index.gpg.key` under `testdata/`

Previously, there were two steps in the test workflow for the Linux ARM64 artifact upload. Although it did no real harm
since it simply replaced the artifact from the first upload with a duplicate, it does slow down the workflow and adds a
little more of a maintenance burden, so better to remove it.

Unquoted variables in shell commands can result in very confusing bugs caused by unexpected interpretation of characters
in the variable contents by the shell, such as globbing and word splitting.

The immediate motivation for this change is that the unquoted certificate password for the macOS notarization guaranteed
a someone a headache when the password wasn't so well behaved as the author of the previously fragile command had
assumed:

security: SecKeychainItemImport: MAC verification failed during PKCS12 import (wrong password?)

When multiple libraries contain files matching an `#include` directive, Arduino CLI must pick one. Multiple factors are
used in order to make an intelligent determination of which library is best. In order to enhance this determination, the
library.properties `name` value is now one of those factors. The other factors are already documented in the "Sketch
Build Process" documentation, but this newly added feature was previously undocumented.

* Improved lib detection: check for matching name in library.properties

The library may be stored in a directory that doesn't match the library
name, for example we had a case in the wild where the directories:

   libraries/onewire_2_3_4/...
   libraries/onewireng_1_2_3/...

were used instead of:

   libraries/OneWire/...
   libraries/OneWireNg/...

this lead to incorrect selection of onewireng_1_2_3 when using OneWire.h
(because the OneWireNg had an architecture=avr that had priority over
the architecture=* of onewire_2_3_4).

This commit will restore priority straight.

* Added test for lib resolve improvement

* Lib discovery: always prefer libraries with the correct directory name

* [skip changelog] Add integration test
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>
Co-authored-by: Cristian Maglie <c.maglie@arduino.cc>

Fixes an issue where during installation using wget an
uninitialized variable was read which caused the process to
get stuck.

The GitHub Actions action for installing Task action has graduated from its original home in the experimental
`arduino/action` repository with the move to a dedicated permanent repository at `arduino/setup-task`.

A 1.0.0 release has been made and a `v1` ref that will track all releases in the major version 1 series. Use of the
action's major version ref will cause the workflow to benefit from ongoing development to the action at each patch or
minor release up until such time as a new major release is made. At this time the user will be given the opportunity
to evaluate whether any changes to the workflow are required by the breaking change that triggered the major release
before manually updating the major ref (e.g., `uses: arduino/setup-task@v2`).

* [skip changelog] Update go-paths-helper dependency

* [skip changelog] Lib install dir path is now canonical

This stems mainly from the fact the CI uses 8.3 naming convention for
paths on Windows, that causes several issues when trying to verify that
certain paths are printed in the output of certain commands.

Making sure that canonical paths are set as installation directory for
all libraries makes it easier to test.

For more info on 8.3 paths see: https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#short-vs-long-names

* [skip changelog] Fix esp8266 test

* [skip changelog] Changed test paths to canonical

This reverts commit 15e81edd.

Previously, the Arduino Sketch Specification only documented the requirements for sketch folder names. Since the primary
sketch filename must match the folder name, this appeared at a glance to be self-evident. However, sketches may consist
of multiple files, and so the specification was ambiguous regarding the naming requirements for additional files.

* check whether prevOpts is nil in WipeoutBuildPathIfBuildOptionsChanged's Run

* + debug message

* update from review: improve user message

* fix per review

* add check to buildOptionsJson too

* panic'ing instead of keeping on with mess

* fix use of a constant
Co-authored-by: per1234 <accounts@perglass.com>

* [skip changelog] Add compile with invalid build.options.json test
Co-authored-by: per1234 <accounts@perglass.com>
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>

- Fixed arduino-cli path for Windows specified in the v 0.15.0 changes in UPGRADING.md file

Calling board list command now returns the detected boards sorted by
FQBN alphabetically, Arduino boards are always shown before all the
others.

* Update integration-options.md

Rebrand updates:
Arduino Create = Arduino Cloud now

* [skip changelog] Fix docs formatting
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>

* updated tests

* add first draft of sorting

* finished/fixed implementation of tests

* implementation of sorting function is now correct

* removed sorting from the cli (previously added in commands) and add [DEPRECATED] to the name

* fixed deprecation notice not being printed if installed.json was already present

* fix formatting

* Improved lib detection: check for matching name in library.properties

The library may be stored in a directory that doesn't match the library
name, for example we had a case in the wild where the directories:

   libraries/onewire_2_3_4/...
   libraries/onewireng_1_2_3/...

were used instead of:

   libraries/OneWire/...
   libraries/OneWireNg/...

this lead to incorrect selection of onewireng_1_2_3 when using OneWire.h
(because the OneWireNg had an architecture=avr that had priority over
the architecture=* of onewire_2_3_4).

This commit will restore priority straight.

* Added test for lib resolve improvement

* Lib discovery: always prefer libraries with the correct directory name

* [skip changelog] Add integration test
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>

* Refactored upload output and debug info and removed unused functions

* Skip serial port touch if the port is not connected

* Perform touch only if required

* Slightly change test to set serial port properties

* Add --library flag to compile command

* Fix library prioritization

* [skip changelog] Fix receiver name in LibraryManager functions

* [skip changelog] Fix variables names and some docstrings

* Fix libraries not being recompiled when path to source file changes

Allow upload without specifing port, even if the board requires 1200-bps-touch on the serial port (#1263)

The workflow is not working and never turned out to be useful so it's best to just remove it.

* Add library validation when installing from zip or git

* [skip changelog] Fix tests temp directory deletion on Windows

* [skip changelog] Fix test_install_git_invalid_library test

* [skip changelog] Add more check in lib install git repo tests

* Added linter ignore rules to match current .proto files

* Fixed SERVICE_SUFFIX lint warning

* Fixed RPC_RESPONSE_STANDARD_NAME lint warning

* Fixed RPC_REQUEST_STANDARD_NAME and RPC_REQUEST_RESPONSE_UNIQUE lint warning

There is one error remaining that require a more involved refactoring.

* Fixed ENUM_VALUE_PREFIX and ENUM_VALUE_UPPER_SNAKE_CASE lint warning

* Fixed FIELD_LOWER_SNAKE_CASE lint warning

* Fixed PACKAGE_VERSION_SUFFIX lint warning

* Fixed PACKAGE_DIRECTORY_MATCH lint warning

* Fixed plurals in repeated fields

* Fixed .proto files indentations

* Fixed some multiword names

* Pass of clang-format

* Fixed integration tests for JSON output

* Updated example_client

* Rename archive_file_name to archive_filename for coherence with the rest of the API

* Updated migration guide

* Added lint and format as Taskfile targets

[skip-changelog] Fixed links in docs. Narrowed the amount of files checked by the link-checker. (#1233)

* Fixed internal links to grpc docs

* Only check docs/*.md and various README.md for broken links

Otherwise it will check also pytest-generated READMEs and all .md files
included in unit tests data files.

* Round of go mod tidy in docsgen module