-
-
Notifications
You must be signed in to change notification settings - Fork 13
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
Improve documentation of data format of dependency inputs #73
Comments
Hi @faultfactory. Thanks for your report. Each of the elements of the Your code here: platforms: |
- name: "adafruit:samd"
- source-url: "https://adafruit.github.io/arduino-board-index/package_adafruit_index.json" contains two separate platform definition objects, one for each of the elements of the list. So you have specified that a platform with the ID But what you were intended to do was specify a single platform. To do that, all keys must be in the same element, like this: platforms: |
- name: "adafruit:samd"
source-url: "https://adafruit.github.io/arduino-board-index/package_adafruit_index.json" So the documentation is correct, and the action works just as documented. However, I think this indicates it is not as clear as it should be. We can use this issue to track the need to improve on that. Probably the most helpful thing would be to provide a dedicated example snippet for each of the source type sections under the I think the wording could also be improved to be more clear. If anyone wants to submit pull requests proposing improvements to the documentation, I would be happy to review them.
The code that allows that was added to provided backwards compatibility for workflows using the poorly designed API of the earliest alpha version of the action. It is deprecated and might be removed at any time. Use of that API is strongly discouraged. |
But, this **should** work, per arduino/compile-sketches#73
Describe the problem
Supplying the board
source-url
for the BM.json
file via the platform scheme documented does not work.I searched through the python file to get it working and appended the URL to the
fqbn
field in my action file and it worked.Please update the docs, or make the code match the docs.
To reproduce
Attempt to use a 3rd party board given the instructions in the action documentation.
This failed and gave an error indicating the information was parsed incorrectly.
This worked:
Expected behavior
Explained above.
'arduino/compile-sketches' version
v1.0.1
Additional context
No response
Issue checklist
The text was updated successfully, but these errors were encountered: