Skip to content

[Skip-changelog] Improve documentation regarding ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS #2136

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

Conversation

MatteoPologruto
Copy link
Contributor

Please check if the PR fulfills these requirements

See how to contribute

  • 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)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Documentation enhancement

What is the new behavior?

The documentation has been improved by adding the correct format for the environment variable ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS. Also, config init now fails if a URL saved in additional_urls contains a comma.

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

No

@MatteoPologruto MatteoPologruto added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Apr 3, 2023
@MatteoPologruto MatteoPologruto self-assigned this Apr 3, 2023
@MatteoPologruto MatteoPologruto changed the title [Skip-changelog] Improve documentation regarding ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS [Skip-changelog] Improve documentation regarding ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS Apr 3, 2023
@codecov
Copy link

codecov bot commented Apr 3, 2023

Codecov Report

Patch coverage: 20.00% and project coverage change: -0.02 ⚠️

Comparison is base (7eae0bd) 62.60% compared to head (5b2bc60) 62.59%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2136      +/-   ##
==========================================
- Coverage   62.60%   62.59%   -0.02%     
==========================================
  Files         227      227              
  Lines       19533    19538       +5     
==========================================
+ Hits        12229    12230       +1     
- Misses       6208     6211       +3     
- Partials     1096     1097       +1     
Flag Coverage Δ
unit 62.59% <20.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
internal/cli/config/init.go 75.00% <20.00%> (-4.67%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@MatteoPologruto MatteoPologruto merged commit bfb5f3f into arduino:master Apr 12, 2023
@MatteoPologruto MatteoPologruto deleted the comma-separated-additional-urls branch April 12, 2023 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS not able to take multiple URLs
2 participants