Merge pull request #3162 from jimklimov/FTY-obs

CI: Further updates for GHA/OBS recipes

Author: jimklimov

.github/workflows/01-make-dist.yml

@@ -30,39 +30,40 @@ jobs:
      # FIXME: Prepare/maintain a container image with pre-installed
      #  NUT build/tooling prereqs (save about 3 minutes per run!)
     runs-on: ubuntu-latest
-    permissions:
-      #actions: read
-      actions: write
-      #contents: read
-      contents: write
-      repository-projects: write
-      security-events: write
-      pull-requests: write
-      issues: write
+    #permissions:
+    #  #actions: read
+    #  actions: write
+    #  #contents: read
+    #  contents: write
+    #  repository-projects: write
+    #  security-events: write
+    #  pull-requests: write
+    #  issues: write
 
     strategy:
       fail-fast: false
 
     steps:
     # Post early so this would be about the top comment in the PR trail
     # (easy to see, contents replaced later)
-    - name: "GHA-01: Make dist and docs tarballs - report download URL - t1"
-      uses: thollander/actions-comment-pull-request@v3
-      # if: startsWith(github.ref, 'refs/pull/')
-      continue-on-error: true
-      with:
-        comment-tag: latest-tarball
-        message: Dist and Docs will be linked here after the "make dist" job completes.
-        #github-token: ${{ secrets.MAKE_DIST_TOKEN }}
+
+    #- name: "GHA-01: Make dist and docs tarballs - report download URL - t1"
+    #  uses: thollander/actions-comment-pull-request@v3
+    #  # if: startsWith(github.ref, 'refs/pull/')
+    #  continue-on-error: true
+    #  with:
+    #    comment-tag: latest-tarball
+    #    message: Sticky note -- Dist and Docs tarballs will be linked here after the "make dist" job completes.
+    #    #github-token: ${{ secrets.MAKE_DIST_TOKEN }}
 
     - name: "GHA-01: Make dist and docs tarballs - report download URL - s1"
       uses: marocchino/sticky-pull-request-comment@v2
-      # if: startsWith(github.ref, 'refs/pull/')
+      if: startsWith(github.ref, 'refs/pull/')
       continue-on-error: true
       with:
         header: latest-tarball-sticky
         only_create: true
-        message: Dist and Docs will be linked here after the "make dist" job completes.
+        message: Sticky note -- Dist and Docs tarballs will be linked here after the "make dist" job completes.
         #github-token: ${{ secrets.MAKE_DIST_TOKEN }}
         #GITHUB_TOKEN: ${{ secrets.MAKE_DIST_TOKEN }}
 
@@ -73,13 +74,15 @@ jobs:
         fetch-tags: true
 
     # https://github.com/marketplace/actions/substitute-string
+    # https://docs.github.com/en/actions/reference/workflows-and-actions/variables
+    # https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax
     # Note it warns about "unexpected input(s)" with replacement tokens below,
     # as they are by design not predefined, as far as actions API is concened.
     # They still work for substitutions though.
     - uses: bluwy/substitute-string-action@v3
       id: subst-github-ref-name
       with:
-        _input-text: "${{ github.ref_name }}"
+        _input-text: "${{ github.head_ref || github.ref_name }}"
         " ": _
         "/": _
     - run: echo "${{ steps.subst-github-ref-name.outputs.result }}"
@@ -274,22 +277,30 @@ jobs:
     # FIXME: Something that adds/updates Github Checks would be better
     #  as it would be seen in the list attached to a status icon of any
     #  build (e.g. history of master branch)
-    - name: "GHA-01: Make dist and docs tarballs - report download URL - t2"
-      uses: thollander/actions-comment-pull-request@v3
-      # if: startsWith(github.ref, 'refs/pull/')
-      continue-on-error: true
-      with:
-        comment-tag: latest-tarball
-        message: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.sha }}
-        #github-token: ${{ secrets.MAKE_DIST_TOKEN }}
+
+    #- name: "GHA-01: Make dist and docs tarballs - report download URL - t2"
+    #  uses: thollander/actions-comment-pull-request@v3
+    #  # if: startsWith(github.ref, 'refs/pull/')
+    #  continue-on-error: true
+    #  with:
+    #    comment-tag: latest-tarball
+    #    message: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.event.pull_request.head.sha || github.sha }}
+    #    #github-token: ${{ secrets.MAKE_DIST_TOKEN }}
 
     # https://github.com/marocchino/sticky-pull-request-comment
     - name: "GHA-01: Make dist and docs tarballs - report download URL - s2"
       uses: marocchino/sticky-pull-request-comment@v2
-      # if: startsWith(github.ref, 'refs/pull/')
+      if: startsWith(github.ref, 'refs/pull/')
       continue-on-error: true
       with:
         header: latest-tarball-sticky
-        message: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.sha }}
+        message: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.event.pull_request.head.sha || github.sha }}
         #github-token: ${{ secrets.MAKE_DIST_TOKEN }}
         #GITHUB_TOKEN: ${{ secrets.MAKE_DIST_TOKEN }}
+
+    # https://github.com/marketplace/actions/commit-comment
+    - name: "GHA-01: Make dist and docs tarballs - report download URL - commit comment"
+      uses: peter-evans/commit-comment@v4
+      continue-on-error: true
+      with:
+        body: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.event.pull_request.head.sha || github.sha }}

NEWS.adoc

@@ -81,6 +81,13 @@ https://github.com/networkupstools/nut/milestone/12
    * Abandoned use of obsolete `gethostbyname()` in favour of `getaddrinfo()`.
      Extended to be IPv6-capable along the way. [#1209]
 
+ - `nhs_ser` driver updates:
+   * Driver source code includes a table to map baud rates (defined by the OS
+     as C macros) to numbers and strings more useful to the driver program.
+     It was discovered that not all operating systems define all the baud rates
+     referenced by this table, so now several higher speeds would be compiled
+     conditionally. [issue #3163]
+
  - `nutdrv_qx` driver updates:
    * Define an internal `QX_FLAG_MAPPING_HANDLED` to check if the subdriver
      code (mapping table) and the data found from device walk sit together

docs/qa-guide.adoc

@@ -535,6 +535,27 @@ packages.
 * https://build.opensuse.org/
 * https://openbuildservice.org/
 
+It is anticipated that corresponding RPM and DEB recipes will evolve to
+match code base evolution as well as distribution-provided packages, so
+that these builds can be installed as temporary replacements of what the
+distro offers (if new features/fixes are required by the user), and that
+more and more platforms will get supported (not every one of them provides
+all prerequisites at all, or under the same spelling of package names).
+
+It is also anticipated that beside NUT itself, further related components
+would be built in those OBS projects, e.g. the NUT-hosted fork of `libmodbus`
+with support of USB RTU until that gets merged into upstream, or clients
+like WMNut.
+
+Resulting packages for several Linux platforms can be seen at:
+
+* https://build.opensuse.org/project/show/home:networkupstools:nut-releases/nut
+  for tagged releases
+* https://build.opensuse.org/package/show/home:networkupstools:nut-stable/nut
+  for iterations of the `master` branch
+* Sibling OBS projects should automatically spawn and disappear nearby
+  for pull requests
+
 Continuous Integration (NUT CI farm) build agent preparation
 ------------------------------------------------------------
 [[NUTCI_farm_agents]]

drivers/nhs_ser.c

@@ -43,7 +43,7 @@
 #include <math.h>
 
 #define DRIVER_NAME	"NHS Nobreak Drivers"
-#define DRIVER_VERSION	"0.03"
+#define DRIVER_VERSION	"0.04"
 #define MANUFACTURER	"NHS Sistemas Eletronicos LTDA"
 
 #define DEFAULTBAUD	2400
@@ -96,10 +96,22 @@ static baud_rate_t baud_rates[] = {
 	{ B921600,	921600,	"921600 bps" },
 	{ B1500000,	1500000,	"1.5 Mbps" },
 	{ B2000000,	2000000,	"2 Mbps" },
+/* NOTE: Per https://github.com/networkupstools/nut/issues/3163
+ * not all platforms offer all baud rates, so we wrap some into
+ * conditional uses.
+ */
+#ifdef B2500000
 	{ B2500000,	2500000,	"2.5 Mbps" },
+#endif
+#ifdef B3000000
 	{ B3000000,	3000000,	"3 Mbps" },
+#endif
+#ifdef B3500000
 	{ B3500000,	3500000,	"3.5 Mbps" },
+#endif
+#ifdef B4000000
 	{ B4000000,	4000000,	"4 Mbps" },
+#endif
 };
 #define NUM_BAUD_RATES (sizeof(baud_rates) / sizeof(baud_rates[0]))