GitLab

For the sake of portability of tasks, Task uses `mvdan.cc/sh` to provide an command interpreter that is independent of
the environment. While one of the great strengths of Task, this produces unexpected results in some rare cases. This is
one of those cases. There is some unusual interaction between `mvdan.cc/sh`, Windows, and running the `rice embed-go`
command from the subshell created by the parentheses in this command:

```
$ task i18n:update
←[32mtask: [i18n:update] go run ./i18n/cmd/main.go catalog generate . > ./i18n/data/en.po
←[0m←[32mtask: [i18n:generate] git add -N ./i18n/data
←[0m←[32mtask: [i18n:generate] git diff --exit-code ./i18n/data &> /dev/null || (cd ./i18n && rice embed-go)
←[0merror reading package: go/build: go list github.com/arduino/arduino-cli/i18n: exec: "go": executable file not found in %PATH%
```

It is my belief that the sole purpose of these parentheses was to group the commands and that there is no need to run
these commands in a subshell. If so, the change to using braces to group the commands without the creation of a subshell
will have no functional effect on the commands, but will allow the task to run on Windows.

Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>

* Refactor codebase to use a single Sketch struct

* Add back removed legacy test

* Changed Sketch struct to not use pointers

* Fix small comment

* Fix checkSketchCasing to work with .pde files too

* Add tests loading Sketch with symlinks

* Update UPGRADING.md

* Clarify a code comment

* Add some more tests for Sketches with symlinks

* Fix Sketch symlinks tests for Windows

* Implemented dry-run for upload and burn-bootloader

* Reduced Reset timeout in dry-run mode

* Fix discovery client

* Fix client_example

* Fixed BoardWatch message loop

* Upgraded go-properties-orderedmap to v1.5.0

* Added a couple of utility functions

* Update arduino/cores/packagemanager/package_manager.go
Co-authored-by: per1234 <accounts@perglass.com>

* Make linter happy
Co-authored-by: per1234 <accounts@perglass.com>

Also fixed a bug that prevented tools-reload after auto install in some
rare circumstances (almost impossible to trigger actually).

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>

In the early days of Arduino CLI's gRPC interface, the protocol buffer compilation was done via `go generate`, configured
by a directive comment. The `protoc:compile` task is now used instead, but the old directive was left in place, where it
became outdated through changes to the repository structure.

This directive no longer functions or serves a purpose and might cause confusion to contributors. So it should be removed.

The key names used in Arduino CLI's JSON output were made consistent and standardized. One of the helper functions for
the integration tests was not updated accordingly. This was missed because it is only used when running the tests locally
due to requiring a board to be connected to the computer.

* added '.tpp' file ext to known list

* Add support for .ipp Sketch files extension

* Add tests for new .tpp and .ipp extensions suppport
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>

* Implemented pluggable discovery board matching

Added also a compatibility layer for existing platforms.

* Fixed docs and linter warnings

* Better comments

* Added tests and fixed a bug

* Fix loading platforms with malformed boards.txt

* [skip changelog] Fix legacy tests

* [skip changelog] Remove unecessary sentence from documentation
Co-authored-by: per1234 <accounts@perglass.com>

* [skip changelog] Fix some docs and comments

* Fix board skipping logic

* [skip changelog] Fix unit tests

* Fix panic if a board has a property that starts with menu
Co-authored-by: per1234 <accounts@perglass.com>

* Removed now useless boilerplate for BoardList

* Fixed wrong 'break'

I guess it was meant to exit from the outer loop and not the select.

* Added Port object in grpc API

* serial-discovery now talks Pluggable Discovery protocol v1

* [breaking] Split rpc Init and remove Rescan function

* [breaking] Refactored commands package to reflect gRPC changes

* [breaking] Refactored cli package to reflect commands changes

* Fix instance creation for CLI commands that update indexes

* Fix unit tests

* Change update indexes commands to not reload instance after

* Fix installation of builtin tools

* Fix integration tests

* Fix code for linting

* Update i18n files

* Update UPGRADING.md with breaking changes

* Update comment with correct information
Co-authored-by: per1234 <accounts@perglass.com>

* Using callback instead of channel+goroutine for Init

* Enhance platform loading step

* Update client_example to reflect new gRPC changes

* Enhance Init docstring

* Enhance builtin tools installation during Init

* Fix unit test

* Fix integration tests

* [skip changelog] Fix after botched rebase

* Fix issue when using Init to rescan installed core on already initialized instance

* Update generated file from .proto
Co-authored-by: per1234 <accounts@perglass.com>
Co-authored-by: Cristian Maglie <c.maglie@arduino.cc>

* [skip changelog] Update proto files build step

* Added missing go.sum

* Update builders to 1.16.4

* Fixed crossbuild for Linux ARMv6/ARMv7

* Fixed macOS_64bit build
Co-authored-by: Cristian Maglie <c.maglie@arduino.cc>

* 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`).