Skip to content
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

Undocumented behaviour for non-github setup of publish.vcs directive #3408

Open
Gedochao opened this issue Jan 10, 2025 · 1 comment
Open
Labels
bug Something isn't working documentation Improvements or additions to documentation experimental Tickets tied to experimental features. publish command

Comments

@Gedochao
Copy link
Contributor

Version(s)
1.5.4

Describe the bug
Docs don't seem to specify how the //> using publish.vcs directive should be set up for non-GitHub repositories.
https://scala-cli.virtuslab.org/docs/commands/publishing/publish#other-settings
What's there (the url|connection|developer-connection format) seems quite vague.
We need examples, better errors, or some different behaviour.

To Reproduce

//> using publish.vcs https://git.qwertyuiop.de/crater2150/copret.git

yields

[error] Malformed vcs "https://git.qwertyuiop.de/crater2150/copret.git", expected url|connection|developer-connection
[error] //> using publish.vcs https://git.qwertyuiop.de/crater2150/copret.git

Expected behaviour
I'd expect the reproduction to either pass, or for documentation to provide examples how to handle non-github repositories.

Extra context

@Gedochao Gedochao added bug Something isn't working documentation Improvements or additions to documentation publish command experimental Tickets tied to experimental features. labels Jan 10, 2025
@Gedochao
Copy link
Contributor Author

A valid example of a generic vcs value can be found here:

"https://github.com/VirtusLab/scala-cli.git|scm:git:github.com/VirtusLab/scala-cli.git|scm:git:[email protected]:VirtusLab/scala-cli.git"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation experimental Tickets tied to experimental features. publish command
Projects
None yet
Development

No branches or pull requests

1 participant