Skip to content

Improve documentation of data format of dependency inputs #73

Open
@faultfactory

Description

@faultfactory

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.

      - name: Compile Arduino Sketches
        uses: arduino/compile-sketches@v1
        with:
          fqbn: 'adafruit:samd:adafruit_feather_m4_can'
          platforms:  |
            - name: "adafruit:samd"
            - source-url: "https://adafruit.github.io/arduino-board-index/package_adafruit_index.json"
          libraries: |
            - name: CAN Adafruit Fork
            - name: SafeString

This worked:

- name: Compile Arduino Sketches
        uses: arduino/compile-sketches@v1
        with:
          fqbn: 'adafruit:samd:adafruit_feather_m4_can https://adafruit.github.io/arduino-board-index/package_adafruit_index.json'
          libraries: |
            - name: CAN Adafruit Fork
            - name: SafeString

Expected behavior

Explained above.

'arduino/compile-sketches' version

v1.0.1

Additional context

No response

Issue checklist

  • I searched for previous reports in the issue tracker
  • I verified the problem still occurs when using the latest version
  • My report contains all necessary details

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions