Merge pull request #6274 from desumn/master

Make it so pin list display the current revision of the pinned repo

.github/scripts/main/main.sh

@@ -127,6 +127,9 @@ if [ "$OPAM_TEST" = "1" ]; then
   fi
   cd $CACHE/opam-rt
   git fetch origin
+  if [ "$GITHUB_EVENT_NAME" = "pull_request" ] && git ls-remote --exit-code origin "$GITHUB_PR_USER/$BRANCH" ; then
+    BRANCH=$GITHUB_PR_USER/$BRANCH
+  fi
   if git ls-remote --exit-code origin $BRANCH ; then
     if git branch | grep -q $BRANCH; then
       git checkout $BRANCH

.github/workflows/ci.ml

@@ -378,7 +378,9 @@ let main_test_job ~analyse_job ~build_linux_job ~build_windows_job:_ ~build_macO
   let matrix = platform_ocaml_matrix ~fail_fast:false start_latests_ocaml in
   let host = host_of_platform platform in
   let ocamlv = "${{ matrix.ocamlv }}" in
-  job ~oc ~workflow ?section ~runs_on:(Runner [runner]) ~env:[("OPAM_TEST", "1")] ~matrix ~needs ("Test-" ^ name_of_platform platform)
+  job ~oc ~workflow ?section ~runs_on:(Runner [runner])
+    ~env:[("OPAM_TEST", "1"); ("GITHUB_PR_USER", "${{ github.event.pull_request.user.login }}")]
+    ~matrix ~needs ("Test-" ^ name_of_platform platform)
     ++ only_on MacOS (install_sys_packages ["coreutils"; "gpatch"] ~descr:"Install gnu coreutils" [MacOS])
     ++ checkout ()
     ++ only_on Linux (run "Install bubblewrap" ["sudo apt install bubblewrap"])

.github/workflows/main.yml

@@ -282,6 +282,7 @@ jobs:
       fail-fast: false
     env:
       OPAM_TEST: 1
+      GITHUB_PR_USER: ${{ github.event.pull_request.user.login }}
     steps:
     - name: Checkout tree
       uses: actions/checkout@v4
@@ -336,6 +337,7 @@ jobs:
       fail-fast: false
     env:
       OPAM_TEST: 1
+      GITHUB_PR_USER: ${{ github.event.pull_request.user.login }}
     steps:
     - name: Install gnu coreutils
       run: brew install coreutils gpatch

master_changes.md

@@ -43,6 +43,7 @@ users)
 ## Config
 
 ## Pin
+  * [NEW] Make it so pin list display the current revision of a pinned repository in a new column [#6274 @desumn - fix #5533]
 
 ## List
 
@@ -137,6 +138,7 @@ users)
 ## Github Actions
   * Add a doc generation job under linux [#5349 @rjbou]
   * Update the github action scripts now that homebrew renamed the GNU patch binary to gpatch [#6296 @kit-ty-kate]
+  * Add branch scheme `username/branch` for opam-rt specific branch to use [#6274 @rjbou]
 
 ## Doc
   * Update the command to install opam to point to the new simplified url on opam.ocaml.org [#6226 @kit-ty-kate]

src/client/opamCommands.ml

@@ -3199,7 +3199,10 @@ let pin_doc = "Pin a given package to a specific version or source."
 let pin ?(unpin_only=false) cli =
   let doc = pin_doc in
   let commands = [
-    cli_original, "list", `list, [], "Lists pinned packages.";
+    cli_original, "list", `list, [], 
+    "Lists pinned packages. \
+     If the source is a remote repository, \
+     displays the hash representing its state.";
     cli_from cli2_1, "scan", `scan, ["DIR"],
     "Lists available packages to pin in directory.";
     cli_original, "add", `add, ["PACKAGE"; "TARGET"],

src/client/opamPinCommand.ml

@@ -764,10 +764,25 @@ let list st ~short =
                   (OpamPackage.version_to_string inst))]
         with Not_found -> OpamConsole.colorise `yellow "(uninstalled)", []
       in
+      let vcs_revision =
+        let open OpamStd.Option.Op in
+        url >>| OpamFile.URL.url >>= fun url ->
+        match url.OpamUrl.backend with
+        | #OpamUrl.version_control ->
+          let srcdir = OpamSwitchState.source_dir st nv in
+          let color, rev =
+            match OpamProcess.Job.run (OpamRepository.revision srcdir url) with
+            | None -> (`red, "error while fetching current revision")
+            | Some ver -> (`magenta, OpamPackage.Version.to_string ver)
+          in
+          Some (Printf.sprintf "(at %s)" (OpamConsole.colorise color (rev)))
+        | _ -> None
+      in
       [ OpamPackage.to_string nv;
         state;
         OpamConsole.colorise `blue kind;
-        String.concat " " (target::extra) ]
+        String.concat " " (target::extra);
+        OpamStd.Option.default "" vcs_revision ]
     with Not_found ->
       [ OpamPackage.to_string nv;
         OpamConsole.colorise `red " (no definition found)" ]

tests/reftests/pin.test

@@ -182,9 +182,9 @@ The following actions will be performed:
 -> installed no-url.ved
 Done.
 ### : list
-### opam pin list
-nip-git.ved      git      git+file://${BASEDIR}/nip-git#master
-nip-git2.ved     git      git+file://${BASEDIR}/nip-git2#master
+### opam pin list | '  \(at [0-9a-f]+\)$' -> '  (at HASH)'
+nip-git.ved      git      git+file://${BASEDIR}/nip-git#master   (at HASH)
+nip-git2.ved     git      git+file://${BASEDIR}/nip-git2#master  (at HASH)
 nip-path.ved     rsync    file://${BASEDIR}/nip-path
 nip-path2.ved    rsync    file://${BASEDIR}/nip-path2
 nip-path3.ved    rsync    file://${BASEDIR}/nip-path3
@@ -332,11 +332,11 @@ The following actions will be performed:
 [NOTE] Pinning command successful, but your installed packages may be out of sync.
 # Return code 31 #
 ### : list
-### opam pin list
+### opam pin list | '  \(at [0-9a-f]+\)$' -> '  (at HASH)'
 nip.1                         version           1
 nip-git.ved                   rsync             file://${BASEDIR}/nip-git
-nip-git2.ved                  git               git+file://${BASEDIR}/nip-git2#master
-nip-git3.ved                  git               git+file://${BASEDIR}/nip-git3#master
+nip-git2.ved                  git               git+file://${BASEDIR}/nip-git2#master  (at HASH)
+nip-git3.ved                  git               git+file://${BASEDIR}/nip-git3#master  (at HASH)
 nip-path.ved                  rsync             file://${BASEDIR}/nip-path
 nip-path3.ved                 rsync             file://${BASEDIR}/nip-path3
 no-url.1       (uninstalled)  local definition
@@ -407,8 +407,8 @@ The following actions will be performed:
 -> installed nip-path2.ved
 Done.
 ### : list
-### opam pin list
-nip-git.ved      git    git+file://${BASEDIR}/nip-git#master
+### opam pin list | '  \(at [0-9a-f]+\)$' -> '  (at HASH)'
+nip-git.ved      git    git+file://${BASEDIR}/nip-git#master  (at HASH)
 nip-git2.ved     rsync  file://${BASEDIR}/nip-git2
 nip-path.ved     rsync  file://${BASEDIR}/nip-path
 nip-path2.ved    rsync  file://${BASEDIR}/nip-path2
@@ -452,8 +452,8 @@ Done.
 # Name    # Installed # Synopsis
 nip-path  ved         pinned to version ved at file://${BASEDIR}/nip-path
 nip-path2 ved         pinned to version ved at file://${BASEDIR}/nip-path2
-### opam pin list
-nip-git4.ved   (uninstalled)  git    git+file://${BASEDIR}/nip-git4#master
+### opam pin list | '  \(at [0-9a-f]+\)$' -> '  (at HASH)'
+nip-git4.ved   (uninstalled)  git    git+file://${BASEDIR}/nip-git4#master  (at HASH)
 nip-path.ved                  rsync  file://${BASEDIR}/nip-path
 nip-path2.ved                 rsync  file://${BASEDIR}/nip-path2
 ### find OPAM/actions/lib -name '*.t' | sort
@@ -570,11 +570,11 @@ The following actions will be performed:
 ### :::::::::::::::::::::::
 ### opam switch kinds
 ### : pin list
-### opam pin list
+### opam pin list | '  \(at [0-9a-f]+\)$' -> '  (at HASH)'
 nip.1                         version           1
 nip-git.ved                   rsync             file://${BASEDIR}/nip-git
-nip-git2.ved                  git               git+file://${BASEDIR}/nip-git2#master
-nip-git3.ved                  git               git+file://${BASEDIR}/nip-git3#master
+nip-git2.ved                  git               git+file://${BASEDIR}/nip-git2#master  (at HASH)
+nip-git3.ved                  git               git+file://${BASEDIR}/nip-git3#master  (at HASH)
 nip-path.ved                  rsync             file://${BASEDIR}/nip-path
 nip-path3.ved                 rsync             file://${BASEDIR}/nip-path3
 no-url.1       (uninstalled)  local definition