add source-url configuration to dist.ini (#181)

skaji · May 29, 2024 · 3c6b83e · 3c6b83e
1 parent 0f50639
commit 3c6b83e
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,11 @@ Yes. Use `dist.ini`:
 
 ```ini
 ; dist.ini
-name = Your-Module-Name
+name = Your::Module::Name
+
+; mi6 automatically guesses source-url by `git remote -v`.
+; if it doesn't work for some reasons, you can specify source-url:
+source-url = https://github.com/you/Your-Module-Name.git
 
 [ReadmeFromPod]
 ; if you want to disable generating README.md from main module's pod, then:

diff --git a/dist.ini b/dist.ini
@@ -1,4 +1,5 @@
 name = App::Mi6
+source-url = https://github.com/skaji/mi6.git
 
 [ReadmeFromPod]
 filename = lib/App/Mi6.rakumod

diff --git a/lib/App/Mi6.rakumod b/lib/App/Mi6.rakumod
@@ -278,7 +278,7 @@ method regenerate-meta($module, $module-file) {
         provides      => config("AutoScanPackages", "enabled", :default<true>) eq "false"
                            ?? ($already<provides> || self.find-provides())
                            !! self.find-provides(),
-        source-url    => $already<source-url> || find-source-url(),
+        source-url    => find-source-url(),
         resources     => $already<resources> || [],
         tags          => $already<tags> || [],
         license       => $already<license> || guess-license(),
@@ -352,13 +352,16 @@ my $GIT-REMOTE-REGEXP = rx{^[
 ]$};
 
 sub find-source-url() {
-    my @line = mi6run("git", "remote", "-v", :out, :!err).out.lines(:close);
-    return "" unless @line;
-    my $url = gather for @line -> $line {
-        my ($name, $url) = $line.split(/\s+/);
-        if $name eq "origin" and $url {
-            take $url;
-            last;
+    my $url = config("_", "source-url");
+    if !$url {
+        my @line = mi6run("git", "remote", "-v", :out, :!err).out.lines(:close);
+        return "" unless @line;
+        $url = gather for @line -> $line {
+            my ($name, $url) = $line.split(/\s+/);
+            if $name eq "origin" and $url {
+                take $url;
+                last;
+            }
         }
     }
     return "" unless $url;
@@ -496,7 +499,11 @@ Yes. Use C<dist.ini>:
 =begin code :lang<ini>
 
 ; dist.ini
-name = Your-Module-Name
+name = Your::Module::Name
+
+; mi6 automatically guesses source-url by `git remote -v`.
+; if it doesn't work for some reasons, you can specify source-url:
+source-url = https://github.com/you/Your-Module-Name.git
 
 [ReadmeFromPod]
 ; if you want to disable generating README.md from main module's pod, then:

diff --git a/xt/01-actual.rakutest b/xt/01-actual.rakutest
@@ -82,6 +82,7 @@ my $tempdir = tempdir;
     "lib/Hello/World5.pm6".IO.spurt("");
     "dist.ini".IO.spurt: q:to/EOF/;
     name = Hello::World
+    source-url = https://github.com/foo/bar.git
     [PruneFiles]
     filename = lib/Hello/World5.pm6
     [MetaNoIndex]
@@ -97,6 +98,7 @@ my $tempdir = tempdir;
         "Hello::World1" => "lib/Hello/World1.rakumod",
         "Hello::World2" => "lib/Hello/World2.pm6",
     };
+    is $meta<source-url>, "https://github.com/foo/bar.git";
 }
 
 {