Library not included, when source-path: points to private repo

[aliphys]

Describe the problem

I want to check that the examples in library A compile correctly prior to public release. However, library A is dependant upon library B. Both libraries are private.

The compile-sketches-private.yml workflow works for library B, but not library A.

To reproduce

1. Create two private repos. Let's call them LibA and LibB. LibB has no external dependancies, outside what is inside the library manager. LibA however is dependant upon LibB (i.e. has #include "LibB" in the example sketches)
2. Copy the compile-sketches-private.yml workflow to the .github/workflows folder in each repo. Configure the fqbn: and add libraies from the library manager (e.g. libraries: - name: Servo)
3. Inside the compile-sketches-private.yml for LibA, refer to LibB as follows:

 libraries: |
            # Install the library from the local path.
            - source-path: ./
            - source-path: https://github.com/arduino-libraries/LibB

4. When running the workflow, I get a message stating the following:

Error: Library source path: https:/github.com/arduino-libraries/LibB doesn't exist
Error: Process completed with exit code 1.

Expected behavior

Private libraries to which my account (or the organisation hosting it) have access to should be acceptable entries to source-path:

'arduino/compile-sketches' version

per1234/.github@b7b3433

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

[aliphys]

In this issue, I requested that the Expected behaviour should be: Private libraries to which my account (or the organisation hosting it) have access to should be acceptable entries to source-path:

However, source-path: can only be used for location relative to the current repository location. The correct syntax (as pointed out by @sebromero ) is source-url:

This is also stated in the documentation.

compile-sketches/README.md

Lines 100 to 116 in e841385

	##### Local path
	Keys:
	- **`source-path`** - (**required**) path to install as a platform. Relative paths are assumed to be relative to the root of the repository.
	- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
	##### Repository
	Keys:
	- **`source-url`** - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
	- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
	- **`version`** - [Git ref](https://git-scm.com/book/en/v2/Git-Internals-Git-References) of the repository to checkout. The special version name `latest` will cause the latest tag to be used.
	- **Default**: the repository is checked out to the tip of the default branch.
	- **`source-path`** - path to install as a platform. Paths are relative to the root of the repository.
	- **Default**: root of the repository.

Closing issue, as not relavent

[aliphys]

See arduino-libraries/Arduino_UnifiedStorage@0d9eaaf

[per1234]

Thanks for your report @aliphys.

The correct syntax (as pointed out by @sebromero ) is source-url:

This is true, but even with that error fixed in the workflow:

libraries: |
  - source-url: https://github.com/arduino-libraries/LibB.git

the installation of the dependency would still fail if arduino-libraries/LibB is a private repository. Installation of dependencies from private repositories is supported by the action using the standard capabilities of Git, GitHub, and GitHub Actions, but the necessary configuration is fairly complex so I think it would be useful to provide some guidance about that. I have submitted a PR to add this information to the documentation: #174

Since you have a valuable perspective on this subject as someone who was recently attempting to use the action in the targeted use case, I would appreciate it if you would review that PR.