Re: [PR PATCH] [Updated] ci: add step to verify the functionality of update-check

[classabbyamp <classabbyamp@users.noreply.github.com>]

[-- Attachment #1: Type: text/plain, Size: 785 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages update-check-ci
https://github.com/void-linux/void-packages/pull/44927

ci: add step to verify the functionality of update-check
runs update-check on all changed templates, then errors only if there was an issue with the update-check. does not error if further updates are available, as there may be a good reason not to update to those versions

example output: 
![image](https://github.com/void-linux/void-packages/assets/5366828/e3d8d36d-c22a-4095-a570-4defd5c29747)


#### Testing the changes
- I tested the changes in this PR: **YES**



A patch file from https://github.com/void-linux/void-packages/pull/44927.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-update-check-ci-44927.patch --]
[-- Type: text/x-diff, Size: 4557 bytes --]

From ad5871ce73ec368984dfdb5c93d8979724bde298 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Sat, 8 Jul 2023 15:05:19 -0400
Subject: [PATCH 1/3] ci: add step to verify the functionality of update-check

---
 .github/workflows/build.yaml         |  9 +++++++++
 common/travis/verify-update-check.sh | 22 ++++++++++++++++++++++
 2 files changed, 31 insertions(+)
 create mode 100755 common/travis/verify-update-check.sh

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index eb4fb7c85be9..4c338bc328aa 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -120,3 +120,12 @@ jobs:
           cd /
           "$here/common/travis/check-install.sh" "$BOOTSTRAP" "$ARCH"
           )
+
+      - name: Verify update-check
+        if: matrix.config.arch == 'x86_64' # no point in running this multiple times
+        run: |
+          (
+          here="$(pwd)"
+          cd /
+          "$here/common/travis/verify-update-check.sh"
+          )
diff --git a/common/travis/verify-update-check.sh b/common/travis/verify-update-check.sh
new file mode 100755
index 000000000000..237d3c0d244f
--- /dev/null
+++ b/common/travis/verify-update-check.sh
@@ -0,0 +1,22 @@
+#!/bin/sh
+# runs update-check on all changed templates, then errors only if there was an
+# issue with the update-check. does not error if further updates are available,
+# as there may be a good reason not to update to those versions
+
+set -e
+
+xbps-install -Syu curl grep
+export XBPS_UPDATE_CHECK_VERBOSE=yes
+err=0
+
+while read -r pkg; do
+	/bin/echo -e "\x1b[34mVerifying update-check of $pkg:\x1b[0m"
+	{
+		/hostrepo/xbps-src update-check "$pkg" 2>&1 || err=1
+	} | tee /tmp/update-check.log
+	if grep -q 'NO VERSION' /tmp/update-check.log; then
+		echo "::warning file=srcpkgs/$pkg/template,line=1,title=update-check failed::verify and fix update-check for $pkg"
+	fi
+done < /tmp/templates
+
+exit $err

From 2da73d9b614e3eea72eb6704d72ff0bba410df6c Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Sat, 8 Jul 2023 15:30:14 -0400
Subject: [PATCH 2/3] ci: make xlint non-fatal

sometimes xlint has false-positives that could lead to packages waiting
to be merged for longer because of the failed CI status. xlint issues
are already reported via annotation so this should be fine.
---
 .github/workflows/build.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 4c338bc328aa..63f4030e86fb 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -31,7 +31,7 @@ jobs:
       - run: common/travis/changed_templates.sh
       - run: common/travis/fetch-xbps.sh
       - run: common/travis/fetch-xtools.sh
-      - run: common/travis/xlint.sh
+      - run: common/travis/xlint.sh || true
 
   # Build changed packages.
   build:

From b08fe88742f499be48b40b8121f7d0b45a24ad51 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Sat, 8 Jul 2023 15:34:58 -0400
Subject: [PATCH 3/3] common/xbps-src/shutils/update_check: add ability to
 disable update-check

useful for cases where update checking does not make sense or is
impossible
---
 Manual.md                               | 4 ++++
 common/xbps-src/shutils/update_check.sh | 3 +++
 2 files changed, 7 insertions(+)

diff --git a/Manual.md b/Manual.md
index 63f10f354582..56ded0559d49 100644
--- a/Manual.md
+++ b/Manual.md
@@ -905,6 +905,10 @@ in url. Defaults to `(|v|$pkgname)[-_.]*`.
 part that follows numeric part of version directory
 in url. Defaults to `(|\.x)`.
 
+- `disabled` can be set to disable update checking for the package,
+in cases where checking for updates is impossible or does not make sense.
+This should be set to a string describing why it is disabled.
+
 <a id="patches"></a>
 ### Handling patches
 
diff --git a/common/xbps-src/shutils/update_check.sh b/common/xbps-src/shutils/update_check.sh
index e656cf06fbcc..882764100577 100644
--- a/common/xbps-src/shutils/update_check.sh
+++ b/common/xbps-src/shutils/update_check.sh
@@ -13,6 +13,9 @@ update_check() {
         if [ "$XBPS_UPDATE_CHECK_VERBOSE" ]; then
             echo "using $XBPS_TARGET_PKG/update overrides" 1>&2
         fi
+        if [ -n "$disabled" ]; then
+            echo "update-check DISABLED for $original_pkgname: $disabled" 1>&2
+        fi
     elif [ -z "$distfiles" ]; then
         if [ "$XBPS_UPDATE_CHECK_VERBOSE" ]; then
             echo "NO DISTFILES found for $original_pkgname" 1>&2