GitLab

The ability to configure Arduino CLI via environment variables is only documented by a mention in the integration options article, which is not an obvious place to look for that information. Since this information didn't fit well in any of the existing pages, it makes sense to add a dedicated page, and add some documentation for the other two configuration methods as well. Although there is existing documentation for the other configuration methods elsewhere in the docs, it is missing some useful specifics, which wouldn't be appropriate to add there.

* [skip changelog] Add documentation for library components of the gRPC interface

Comments added to the .proto files are included in the generated gRPC interface documentation.

* Correct documentation re: relative vs absolute paths provided by Library message fields
Co-authored-by: Roberto Sora <r.sora@arduino.cc>

* Use preferred "platform" term in gRPC interface documentation

The official term is now "platform", rather than the previous ambiguous "core".
Co-authored-by: Roberto Sora <r.sora@arduino.cc>

* Fix formatting of gRPC interface documentation

* Fix incorrect documentation for task_progress field of LibraryUninstall response

* Document that library version is the key of the releases map

* Update gRPC interface code comments
Co-authored-by: Roberto Sora <r.sora@arduino.cc>

* Added scaffolding for external programmer support

* Added programmers extraction in arduino/cores module

* Implemented programmers list command

* Print upload command line in verbose mode

* Added programmer option to compile command

* External programmer implementation

* Factored function runTool in upload

This will turn out useful for burn-bootloader that requires to run
two actions in a row ("erase" and "bootloader").

* Implemented burn-bootloader

* Increased tracing log

* Test fix

* Added BurnBootloder action

* Make the upload port parameter mandatory only when really needed

* Fixed nil pointer exception when burning-bootloader

* Added sanity check on upload parameters

* add basic implementation of bash completion

* update cobra to 1.0.0 because of https://github.com/spf13/cobra/pull/1048

* add support for zsh and fish, improved help messages

* add flag ´--no-descriptions´ to disable automatic command description (for shells that supports it)

* fix fish not supporting env variables with dash in the name

* fixed zsh completion not working

* revert "#compdef" patch

* add check on --no-description flag
add comments regarding "hacks"
change Replacer with ReplaceAll (for readability)

* add docs

* Apply suggestions from code review

fix typos and corrections
Co-authored-by: per1234 <accounts@perglass.com>

* forgot a space

* fix fish docs

* add test for completion
Co-authored-by: per1234 <accounts@perglass.com>

This removes the --relax option, potentially producing slightly bigger code for the atmega2560. On the longer term, the AVR core should just add this option for all boards, but this is not currently the case yet because removing --relax also works around a gcc miscompilation (see arduino/ArduinoCore-avr#339).

Close: https://github.com/arduino/arduino-cli/issues/639

* Fixed skethbook+bootloader hex merger.

Previous merger doesn't take into account .bin bootloaders and it may
have problems if .hex data is not sorted by address.

* output a merged sketch+bootloader bin file too

* Replace logger with utils.LogIfVerbose
Co-authored-by: Martino Facchin <m.facchin@arduino.cc>

The portable condition was wrong (it checked for 'non-existance' instead
of 'existance').

I've replaced all the conditions with the more readable path.Exist
method.

This section of the documentation was written with a focus on the Arduino IDE, and thus was not very friendly to Arduino CLI users.

Arduino CLI provides three interfaces for integration:
- command line
- gRPC
- Go library

This is an article written by Massimiliano Pippi, which I have merely converted to Markdown and added some links to.

* [skip changelog] document the docs generation workflow

* clarify how humans should not push to gh-pages

* Apply suggestions from code review
Co-authored-by: per1234 <accounts@perglass.com>
Co-authored-by: per1234 <accounts@perglass.com>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

suceed -> succeed
documentaiton -> documentation
saerching -> searching
plattform -> platform

This commits excludes:

- generated files
- i18n tooling for generating translations files that are not used in
  the final build of the cli.

* fetch available languages from transifex

* fix documentation on i18n update

* add documentation on contributing for i18n workflow

* add po message catalog implementation

* add po parser for i18n cmd

* add po merge function

* add command to generate en po file from source

* add command to update local po files with en catalog change

* add task to generate po files

* add locale option for i18n

* add dependencies for i18n

* add unit test for i18n

* add godoc to exported fields

* add rice box for i18n messages

* add readme for i18n module

* update README to add instruction to install go-rice

* remove warning log in case locale is not found

* add command to pull and push translation files from/to transifex

* remove unused import

* dont generate new rice file if there are no translation changes

* add copyright headers

* use 'tr' function call as indicator for translations

* adding documentation to pull,push translations and adding new languages

* push only the reference translation catalog

* add check on PR for updated catalog not commited

* push message catalog to transifex

* pull translations fro transifex weekly

* get locale identifier from diferent OSes

* get locale identifier from diferent OSes

* match locale algo

* add locale match test

* preserve LF in translation string unchanged

* init config before executing command

* create arduino cmd dynamically

* make all command init dynamically

* save all message occurrences in catalog

* add translatable cli usage template

* add messages for cli usage template

* remove standalone i18n message check

* add more i18n tests

* fix po parsing correctness and implement tests

* fix configuration path search tests

* update catalog command to find go files

* update catalog with new path

* fix docsgen command

* remove dependency on shell script for windows compat

* fix test workflow

* update setup-go to v2

* fail i18n:check task if catalog was not updated

* replace windows separator with forward slash

* use filepath function to translate windows paths

* only update en catalog

The file has been validated with the webservice provided by codecov.

Before the patch:

$ curl --data-binary @.codecov.yml https://codecov.io/validate
Path: coverage->status->project->default->threshold
<shared.validation.helpers.PercentSchemaField object at 0x7f172d3e5a10>.validate(None) raised TypeError('expected string or bytes-like object')

After the patch:

$ curl --data-binary @.codecov.yml https://codecov.io/validate
Valid!

{
  "comment": false,
  "coverage": {
    "status": {
      "patch": false,
      "changes": false,
      "project": {
        "default": {
          "target": 30.0
        }
      }
    }
  }
}

Comments added to the .proto files are included in the generated gRPC interface documentation.

We are currently hitting ~31.8% of test coverage, keeping the threshold
to 35% will mark all the commits as failing.

Previously, if there were many serial port connected, multiple Performing 1200-bps touch reset on serial port /dev/ttyACMxx were printed due to misplacement of the verbose print.

[skip changelog] Use local path for github.com/arduino/arduino-cli module dependency of docsgen (#719)

Previously, docsgen used a pinned version of the github.com/arduino/arduino-cli module, which resulted in the generated command documentation not reflecting updates to the Arduino CLI command line interface made after the pinned version.

The new approach is to use the current version of the module from the local path, resulting in the generated documentation always matching the associated version of Arduino CLI.

* config git in publish step, remove magic string from build script

* expand build.py CLI to simplify action's code

* build when workflow changes

* fetch gh-pages branch

* fix version selector

* Remove testing code

* document who owns commits on gh-pages

* [skip changelog] Document the install script's compatibility with Windows

It's already quite clear that the Homebrew installation method is not available for Windows, so the first option for Windows users is the install script, which is also not well supported on Windows.

* [skip changelog] Make the PATH instructions more prominent in the installation docs

Although the installation script does recommend adding Arduino CLI to PATH, I though it worth providing an explanation of why in installation instructions.

I combined the various download sources into sub-headings of a single "Download" installation option section so that the PATH instructions could be provided prominently only once for that installation option.

* remove unused import

* remove blank line

* introduce mike

* use default 'site' dir for output

* install mike and pin material theme

* add task to build&publish docs using Mike

* publish dev and versioned docs

* narrow down env definition

* add build script to handle versioning

* invoke task, not mike directly

* add configuration for cli httpclient

* add httpclient roundtripper with proxy and user-agent

* add cli httpclient

* set downloader user-agent tp equal cli httpclient

* use cli httpclient on board list command

* add unit tests for httpclient

* add copyright notice

* upgrade downloader to v2 with httpclient injection

* change go.mod to point to upstream downloader project v2

Comments added to the .proto files are included in the generated gRPC interface documentation.

Comments added to the .proto files are included in the generated gRPC interface documentation.

* Deprecated exportFile/importFile in favor of exportDir/importDir

* Updated compile/upload cli commands

* Compile now saves artifacts in 'sketch/build/<FQBN>/...' folder

* Upload now uses export folder

* Test fix: use --output-dir option instead of deprecated --output

* Text fix: no more need to check if "extension won't be added if already present"

* Added Debug.ImportDir and deprecated Debug.ImportFile

* Upload now uses export folder

* Fixed GetCommandLine test

* Fixed test_core_install_esp32

This feature has not been implemented, so the field has no purpose.

Comments added to the .proto files are included in the generated gRPC interface documentation.

Comments added to the .proto files are included in the generated gRPC interface documentation.

Comments added to the .proto files are included in the generated gRPC interface documentation.

Comments added to the .proto files are included in the generated gRPC interface documentation.