Set git branch action (#270)

* feat: add action to set git branch in zenoh deps

* fix: update merge-release-branch to use action

* chore: disable auto-merge while testing

* chore: update action URL

* chore: change inputs to matrix.repo

* fix: fix regex for compute branch

* chore: add missing params to docs

Author: diogomatsubara

.github/workflows/merge-release-branch.yml

@@ -8,21 +8,13 @@ on:
         type: string
         description: The release branch version to merge into main
         required: true
-      repo:
-        type: string
-        description: The repository to create the PR (org/repo format)
-        required: true
 
   workflow_dispatch:
     inputs:
       version:
         type: string
         description: The release branch version to merge into main
         required: true
-      repo:
-        type: string
-        description: The repository to create the PR (org/repo format)
-        required: true
 
 defaults:
   run:
@@ -32,36 +24,79 @@ jobs:
   merge-release-branch:
     name: Submit PR to merge release branch into main
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        repo:
+          - eclipse-zenoh/zenoh
+          - eclipse-zenoh/zenoh-pico
+          - eclipse-zenoh/zenoh-cpp
+          - eclipse-zenoh/zenoh-c
+          - eclipse-zenoh/zenoh-python
+          - eclipse-zenoh/zenoh-java
+          - eclipse-zenoh/zenoh-kotlin
+          - eclipse-zenoh/zenoh-plugin-dds
+          - eclipse-zenoh/zenoh-plugin-mqtt
+          - eclipse-zenoh/zenoh-plugin-ros2dds
+          - eclipse-zenoh/zenoh-plugin-webserver
+          - eclipse-zenoh/zenoh-backend-filesystem
+          - eclipse-zenoh/zenoh-backend-influxdb
+          - eclipse-zenoh/zenoh-backend-rocksdb
+          - eclipse-zenoh/zenoh-backend-s3
+          - eclipse-zenoh/zenoh-ts
+          - eclipse-zenoh/zenoh-dissector
     steps:
+      - name: Update git/branch in release branch
+        if: ${{ !contains(fromJSON('["eclipse-zenoh/zenoh", "eclipse-zenoh/zenoh-pico", "eclipse-zenoh/zenoh-cpp"]'), matrix.repo) }}
+        uses: ZettaScaleLabs/ci/set-git-branch@set-git-branch-action
+        with:
+          version: ${{ inputs.version }}
+          release-branch: release/${{ inputs.version }}
+          repo: ${{ matrix.repo }}
+          github-token: ${{ secrets.BOT_TOKEN_WORKFLOW }}
+          deps-pattern: zenoh.*
+          deps-git-url: https://github.com/eclipse-zenoh/zenoh.git
+          deps-branch: main
+
+      - name: Compute branch
+        id: compute-branch
+        run:
+          if [ "${{ matrix.repo }}" =~ eclipse-zenoh\/zenoh(?:-(pico|cpp))? ]] ; then
+            echo "branch=release/${{ inputs.version }}" >> $GITHUB_OUTPUT
+          else
+            echo "branch=eclipse-zenoh-bot/post-release-${{ inputs.version }}" >> $GITHUB_OUTPUT
+          fi
+
       - name: Create PR
         id: cpr
         run: |
           pr_url=$(gh pr create \
           --title "chore: Merge release/${{ inputs.version }} into main" \
           --body "Open new development line" \
-          --head release/${{ inputs.version }} \
+          --head ${{ steps.compute-branch.outputs.branch }}
           --base main \
           --label internal \
-          -R ${{ inputs.repo }} \
+          -R ${{ matrix.repo }} \
           )
           echo "pull-request-operation=created" >> $GITHUB_OUTPUT
           pr_number="${pr_url##*/pull/}"
           echo "pull-request-number=$pr_number" >> $GITHUB_OUTPUT
         env:
           GH_TOKEN: ${{ secrets.BOT_TOKEN_WORKFLOW }}
 
-      - name: Enable auto merge for the pull request
-        if: ${{ steps.cpr.outputs.pull-request-operation == 'created' }}
-        run: >
-          gh pr merge "${{ steps.cpr.outputs.pull-request-number }}"
-          --subject "chore: Merge release/${{ inputs.version }} into main (#${{ steps.cpr.outputs.pull-request-number }})"
-          --repo "${{ inputs.repo }}"
-          --auto
-          --merge
-        env:
-          GH_TOKEN: ${{ secrets.BOT_TOKEN_WORKFLOW }}
+      # Disable auto merge while testing
+      #- name: Enable auto merge for the pull request
+      #  if: ${{ steps.cpr.outputs.pull-request-operation == 'created' }}
+      #  run: >
+      #    gh pr merge "${{ steps.cpr.outputs.pull-request-number }}"
+      #    --subject "chore: Merge release/${{ inputs.version }} into main (#${{ steps.cpr.outputs.pull-request-number }})"
+      #    --repo "${{ matrix.repo }}"
+      #    --auto
+      #    --merge
+      #  env:
+      #    GH_TOKEN: ${{ secrets.BOT_TOKEN_WORKFLOW }}
 
       - name: Add the PR as annotation to workflow run
         if: ${{ steps.cpr.outputs.pull-request-operation == 'created' }}
         run: >
-          echo "::notice:: Created PR: https://github.com/${{ inputs.repo }}/pull/${{ steps.cpr.outputs.pull-request-number }}"
+          echo "::notice:: Created PR: https://github.com/${{ matrix.repo }}/pull/${{ steps.cpr.outputs.pull-request-number }}"

dist/build-crates-debian-main.js

@@ -127950,7 +127950,7 @@ __nccwpck_require__.a(module, async (__webpack_handle_async_dependencies__, __we
 /* harmony export */   "ib": () => (/* binding */ packagesDebian),
 /* harmony export */   "lY": () => (/* binding */ buildDebian)
 /* harmony export */ });
-/* unused harmony exports packages, packagesOrdered, bump, bumpDependencies, setRegistry, configRegistry, installBinaryFromGit, build, hostTarget, isPublished */
+/* unused harmony exports packages, packagesOrdered, bump, bumpDependencies, setRegistry, setGitBranch, configRegistry, installBinaryFromGit, build, hostTarget, isPublished */
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0__ = __nccwpck_require__(22037);
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__nccwpck_require__.n(os__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1__ = __nccwpck_require__(71017);
@@ -128134,6 +128134,39 @@ async function setRegistry(path, pattern, registry) {
     }
     core.endGroup();
 }
+/**
+ * Sets the git/branch config of select dependencies.
+ *
+ * @param path Path to the Cargo workspace.
+ * @param pattern A regular expression that matches the dependencies to be
+ * @param gitUrl git url to set in Cargo.toml dependency
+ * @param gitBranch git branch to set in Cargo.toml dependency
+ * updated
+ */
+async function setGitBranch(path, pattern, gitUrl, gitBranch) {
+    core.startGroup(`Setting ${pattern} dependencies' git/branch config`);
+    const manifestPath = `${path}/Cargo.toml`;
+    const manifestRaw = toml.get(manifestPath);
+    let manifest;
+    let prefix;
+    if ("workspace" in manifestRaw) {
+        prefix = ["workspace"];
+        manifest = manifestRaw["workspace"];
+    }
+    else {
+        prefix = [];
+        manifest = manifestRaw;
+    }
+    for (const dep in manifest.dependencies) {
+        if (pattern.test(dep)) {
+            // if the dep has a path set, don't set the git/branch to avoid ambiguities
+            if (!toml.get(manifestPath, prefix.concat("dependencies", dep, "path"))) {
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "git"), gitUrl);
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "branch"), gitBranch);
+            }
+        }
+    }
+}
 /**
  * Stores Cargo registry configuration in `.cargo/config.toml`.
  * @param path Path to the Cargo workspace.

dist/build-crates-standalone-main.js

@@ -127934,7 +127934,7 @@ __nccwpck_require__.a(module, async (__webpack_handle_async_dependencies__, __we
 /* harmony export */   "KD": () => (/* binding */ hostTarget),
 /* harmony export */   "Mj": () => (/* binding */ installBinaryCached)
 /* harmony export */ });
-/* unused harmony exports packages, packagesOrdered, bump, bumpDependencies, setRegistry, configRegistry, packagesDebian, installBinaryFromGit, buildDebian, toDebianVersion, isPublished */
+/* unused harmony exports packages, packagesOrdered, bump, bumpDependencies, setRegistry, setGitBranch, configRegistry, packagesDebian, installBinaryFromGit, buildDebian, toDebianVersion, isPublished */
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0__ = __nccwpck_require__(22037);
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__nccwpck_require__.n(os__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1__ = __nccwpck_require__(71017);
@@ -128118,6 +128118,39 @@ async function setRegistry(path, pattern, registry) {
     }
     core.endGroup();
 }
+/**
+ * Sets the git/branch config of select dependencies.
+ *
+ * @param path Path to the Cargo workspace.
+ * @param pattern A regular expression that matches the dependencies to be
+ * @param gitUrl git url to set in Cargo.toml dependency
+ * @param gitBranch git branch to set in Cargo.toml dependency
+ * updated
+ */
+async function setGitBranch(path, pattern, gitUrl, gitBranch) {
+    core.startGroup(`Setting ${pattern} dependencies' git/branch config`);
+    const manifestPath = `${path}/Cargo.toml`;
+    const manifestRaw = toml.get(manifestPath);
+    let manifest;
+    let prefix;
+    if ("workspace" in manifestRaw) {
+        prefix = ["workspace"];
+        manifest = manifestRaw["workspace"];
+    }
+    else {
+        prefix = [];
+        manifest = manifestRaw;
+    }
+    for (const dep in manifest.dependencies) {
+        if (pattern.test(dep)) {
+            // if the dep has a path set, don't set the git/branch to avoid ambiguities
+            if (!toml.get(manifestPath, prefix.concat("dependencies", dep, "path"))) {
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "git"), gitUrl);
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "branch"), gitBranch);
+            }
+        }
+    }
+}
 /**
  * Stores Cargo registry configuration in `.cargo/config.toml`.
  * @param path Path to the Cargo workspace.

dist/bump-crates-main.js

@@ -81185,7 +81185,7 @@ __nccwpck_require__.a(module, async (__webpack_handle_async_dependencies__, __we
 /* harmony export */   "Mj": () => (/* binding */ installBinaryCached),
 /* harmony export */   "UR": () => (/* binding */ bumpDependencies)
 /* harmony export */ });
-/* unused harmony exports packages, packagesOrdered, setRegistry, configRegistry, packagesDebian, installBinaryFromGit, build, hostTarget, buildDebian, isPublished */
+/* unused harmony exports packages, packagesOrdered, setRegistry, setGitBranch, configRegistry, packagesDebian, installBinaryFromGit, build, hostTarget, buildDebian, isPublished */
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0__ = __nccwpck_require__(2037);
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__nccwpck_require__.n(os__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1__ = __nccwpck_require__(1017);
@@ -81369,6 +81369,39 @@ async function setRegistry(path, pattern, registry) {
     }
     core.endGroup();
 }
+/**
+ * Sets the git/branch config of select dependencies.
+ *
+ * @param path Path to the Cargo workspace.
+ * @param pattern A regular expression that matches the dependencies to be
+ * @param gitUrl git url to set in Cargo.toml dependency
+ * @param gitBranch git branch to set in Cargo.toml dependency
+ * updated
+ */
+async function setGitBranch(path, pattern, gitUrl, gitBranch) {
+    core.startGroup(`Setting ${pattern} dependencies' git/branch config`);
+    const manifestPath = `${path}/Cargo.toml`;
+    const manifestRaw = toml.get(manifestPath);
+    let manifest;
+    let prefix;
+    if ("workspace" in manifestRaw) {
+        prefix = ["workspace"];
+        manifest = manifestRaw["workspace"];
+    }
+    else {
+        prefix = [];
+        manifest = manifestRaw;
+    }
+    for (const dep in manifest.dependencies) {
+        if (pattern.test(dep)) {
+            // if the dep has a path set, don't set the git/branch to avoid ambiguities
+            if (!toml.get(manifestPath, prefix.concat("dependencies", dep, "path"))) {
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "git"), gitUrl);
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "branch"), gitBranch);
+            }
+        }
+    }
+}
 /**
  * Stores Cargo registry configuration in `.cargo/config.toml`.
  * @param path Path to the Cargo workspace.

dist/publish-crates-cargo-main.js

@@ -81070,7 +81070,7 @@ __nccwpck_require__.a(module, async (__webpack_handle_async_dependencies__, __we
 /* harmony export */   "s9": () => (/* binding */ isPublished),
 /* harmony export */   "wS": () => (/* binding */ installBinaryFromGit)
 /* harmony export */ });
-/* unused harmony exports packages, bump, bumpDependencies, packagesDebian, build, hostTarget, buildDebian, toDebianVersion */
+/* unused harmony exports packages, bump, bumpDependencies, setGitBranch, packagesDebian, build, hostTarget, buildDebian, toDebianVersion */
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0__ = __nccwpck_require__(2037);
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__nccwpck_require__.n(os__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1__ = __nccwpck_require__(1017);
@@ -81254,6 +81254,39 @@ async function setRegistry(path, pattern, registry) {
     }
     _actions_core__WEBPACK_IMPORTED_MODULE_2__.endGroup();
 }
+/**
+ * Sets the git/branch config of select dependencies.
+ *
+ * @param path Path to the Cargo workspace.
+ * @param pattern A regular expression that matches the dependencies to be
+ * @param gitUrl git url to set in Cargo.toml dependency
+ * @param gitBranch git branch to set in Cargo.toml dependency
+ * updated
+ */
+async function setGitBranch(path, pattern, gitUrl, gitBranch) {
+    core.startGroup(`Setting ${pattern} dependencies' git/branch config`);
+    const manifestPath = `${path}/Cargo.toml`;
+    const manifestRaw = toml.get(manifestPath);
+    let manifest;
+    let prefix;
+    if ("workspace" in manifestRaw) {
+        prefix = ["workspace"];
+        manifest = manifestRaw["workspace"];
+    }
+    else {
+        prefix = [];
+        manifest = manifestRaw;
+    }
+    for (const dep in manifest.dependencies) {
+        if (pattern.test(dep)) {
+            // if the dep has a path set, don't set the git/branch to avoid ambiguities
+            if (!toml.get(manifestPath, prefix.concat("dependencies", dep, "path"))) {
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "git"), gitUrl);
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "branch"), gitBranch);
+            }
+        }
+    }
+}
 /**
  * Stores Cargo registry configuration in `.cargo/config.toml`.
  * @param path Path to the Cargo workspace.

dist/publish-crates-debian-main.js

@@ -127929,7 +127929,7 @@ __nccwpck_require__.a(module, async (__webpack_handle_async_dependencies__, __we
 /* harmony export */ __nccwpck_require__.d(__webpack_exports__, {
 /* harmony export */   "Mj": () => (/* binding */ installBinaryCached)
 /* harmony export */ });
-/* unused harmony exports packages, packagesOrdered, bump, bumpDependencies, setRegistry, configRegistry, packagesDebian, installBinaryFromGit, build, hostTarget, buildDebian, toDebianVersion, isPublished */
+/* unused harmony exports packages, packagesOrdered, bump, bumpDependencies, setRegistry, setGitBranch, configRegistry, packagesDebian, installBinaryFromGit, build, hostTarget, buildDebian, toDebianVersion, isPublished */
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0__ = __nccwpck_require__(22037);
 /* harmony import */ var os__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__nccwpck_require__.n(os__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1__ = __nccwpck_require__(71017);
@@ -128113,6 +128113,39 @@ async function setRegistry(path, pattern, registry) {
     }
     core.endGroup();
 }
+/**
+ * Sets the git/branch config of select dependencies.
+ *
+ * @param path Path to the Cargo workspace.
+ * @param pattern A regular expression that matches the dependencies to be
+ * @param gitUrl git url to set in Cargo.toml dependency
+ * @param gitBranch git branch to set in Cargo.toml dependency
+ * updated
+ */
+async function setGitBranch(path, pattern, gitUrl, gitBranch) {
+    core.startGroup(`Setting ${pattern} dependencies' git/branch config`);
+    const manifestPath = `${path}/Cargo.toml`;
+    const manifestRaw = toml.get(manifestPath);
+    let manifest;
+    let prefix;
+    if ("workspace" in manifestRaw) {
+        prefix = ["workspace"];
+        manifest = manifestRaw["workspace"];
+    }
+    else {
+        prefix = [];
+        manifest = manifestRaw;
+    }
+    for (const dep in manifest.dependencies) {
+        if (pattern.test(dep)) {
+            // if the dep has a path set, don't set the git/branch to avoid ambiguities
+            if (!toml.get(manifestPath, prefix.concat("dependencies", dep, "path"))) {
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "git"), gitUrl);
+                await toml.set(manifestPath, prefix.concat("dependencies", dep, "branch"), gitBranch);
+            }
+        }
+    }
+}
 /**
  * Stores Cargo registry configuration in `.cargo/config.toml`.
  * @param path Path to the Cargo workspace.