From 9c777a4a681579bb5104ae8acaa9a160adf7bf97 Mon Sep 17 00:00:00 2001 From: Richard Beckmann Date: Sun, 16 Mar 2025 09:19:45 +0000 Subject: rockspec format: improve message for handling GitHub URL Co-authored-by: Caleb Maclennan --- docs/rockspec_format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rockspec_format.md b/docs/rockspec_format.md index a5fe1db9..3a7dfd3d 100644 --- a/docs/rockspec_format.md +++ b/docs/rockspec_format.md @@ -46,7 +46,7 @@ Dependencies are represented in LuaRocks through strings with a package name fol * `https://` - for HTTPS URLs to archive file * `sscm://` - for the SurroundSCM source control manager * `svn://` - for the Subversion source control manager - * **Important:** A source control manager URL cannot start with `http://` `https://`, `ftp://` or `file://`. For example, `https://github.com/keplerproject/wsapi.git` is incorrect, even though it works perfectly fine with `git clone`. The correct one is `git://github.com/keplerproject/wsapi.git`. Also note that only for GitHub URLs `git://` is being treated the same as `git+https://`. This is due to [GitHub's increased security](https://github.blog/security/application-security/improving-git-protocol-security-github/) and preserving backwards compatibility. + * **Important:** A source control manager URL cannot start with `http://` `https://`, `ftp://` or `file://`. For example, `https://github.com/keplerproject/wsapi.git` is incorrect, even though it works perfectly fine with `git clone`. The correct one is `git+https://github.com/keplerproject/wsapi.git`. Also note that only for GitHub URLs `git://` is being automatically handled internally as if it was `git+https://`. This is due to preserve backwards compatibility while still working with [GitHub's increased default security](https://github.blog/security/application-security/improving-git-protocol-security-github/) measures in blocking insecure connection types. * **source.md5** (string) - the MD5 sum for the source archive. Example: "9ca22fd9f9413b54802d3d40b38c4e5c" * **source.file** (string) - the filename of the source archive. Can be omitted if it can be inferred from the `source.url` field. Example: "luasocket-2.0.1.tar.gz" * **source.dir** (string) - the name of the directory created when the source archive is unpacked. Can be omitted if it can be inferred from the `source.file` field. Example: "luasocket-2.0.1" -- cgit v1.2.3-55-g6feb