Skip to content

[skip changelog] Sync install script with template #1396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 13, 2021
Merged

[skip changelog] Sync install script with template #1396

merged 2 commits into from
Aug 13, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 12, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Infrastructure update

  • What is the current behavior?

We have assembled a collection of reusable project assets:
https://github.com/arduino/tooling-project-assets
These assets will be used in the repositories of all Arduino tooling projects.

Some minor improvements and standardizations have been made in the upstream "template" installation script, and those are
introduced to this repository via this pull request.

  • What is the new behavior?

Workflow is synced with the state of the art from upstream.

Notable:

  • ShellCheck compliance

  • Support for specifying nightly build versions (e.g., "nightly-latest") via the script argument

  • Remove cryptic output not of interest to the user (likely forgotten debug artifacts from script development)

  • Does this PR introduce a breaking change, and is
    titled accordingly?

Does this PR introduce a breaking change

No

is titled accordingly

Yes

  • Other information:

Can be tried out before merge by running the copy from this PR's branch:

curl -fsSL https://raw.githubusercontent.com/per1234/arduino-cli/install-script/install.sh | sh -s nightly-latest

(this particular command demos the new nightly install capability)

The script is already in place in the Arduino Lint repository, which has a CI workflow for testing it:
https://github.com/arduino/arduino-lint/actions/workflows/test-install.yml

…rmatting

A standardized style for all Arduino Tooling shell scripts has been established. The `.editorconfig` file is updated
accordingly and all the repository's scripts made compliant with it.
We have assembled a collection of reusable project assets:
https://github.com/arduino/tooling-project-assets
These assets will be used in the repositories of all Arduino tooling projects.

Some minor improvements and standardizations have been made in the upstream "template" installation script, and those are
introduced to this repository via this pull request.

Notable:

- ShellCheck compliance
- Support for specifying nightly build versions (e.g., "nightly-latest") via the script argument
- Remove cryptic output not of interest to the user (likely forgotten debug artifacts from script development)
@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Aug 12, 2021
@per1234 per1234 requested review from cmaglie and umbynos August 12, 2021 22:20
@per1234 per1234 merged commit bec94db into arduino:master Aug 13, 2021
@per1234 per1234 deleted the install-script branch August 13, 2021 08:25
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants