refactor: 引入 1.8.2 版的 The Common Project Template 配置（支持產生並交付釋出包）

Signed-off-by: 林博仁(Buo-ren, Lin) <[email protected]>

Author: brlin-tw

.editorconfig

@@ -41,6 +41,10 @@ trim_trailing_whitespace = false
 # Markdownlint to check instead
 indent_size = unset
 
+[*.{diff,patch}]
+# Trailing whitespaces are unchanged lines in patch files
+trim_trailing_whitespace = false
+
 # Vagrant configuration file
 [Vagrantfile]
 indent_size = 2
@@ -52,3 +56,6 @@ indent_size = 2
 # YAML documents
 [*.{yml,yaml}]
 indent_size = 2
+
+[.*.{yml,yaml}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,18 @@
+# Git path attributes configuration file
+#
+# References:
+#
+# * Git - Git Attributes
+#   https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes
+# * Git - gitattributes Documentation
+#   https://www.git-scm.com/docs/gitattributes
+#
+# Copyright 2023 林博仁(Buo-ren, Lin) <[email protected]>
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
+# Avoid exporting development files to release archive
+/.* export-ignore
+/continuous-integration/ export-ignore
+
+# Keep editorconfig for ease of editing of product files
+/.editorconfig -export-ignore

.github/workflows/README.md

@@ -1,3 +1,10 @@
 # workflows
 
-放置 GitHub Actions 的工作流程(workflow)定義檔
+放置 [GitHub Actions](https://github.com/features/actions) 的工作流程(workflow)定義檔
+
+## 參考資料<br>Reference
+
+* [Features • GitHub Actions](https://github.com/features/actions)  
+  Product page
+* [GitHub Actions Documentation - GitHub Docs](https://docs.github.com/en/actions)  
+  Official documentation

.github/workflows/check-potential-problems.yml

@@ -5,26 +5,41 @@
 # * Workflow syntax for GitHub Actions - GitHub Docs
 #   https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
 #
-# Copyright 2021 林博仁(Buo-ren, Lin) <[email protected]>
+# Copyright 2022 林博仁(Buo-ren, Lin) <[email protected]>
 # SPDX-License-Identifier: CC-BY-SA-4.0
 name: 檢查專案中的潛在問題
 on:
   - push
 jobs:
   check-using-precommit:
     name: 使用 pre-commit 檢查專案中的潛在問題
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
+    env:
+      PIP_CACHE_DIR: ${{ github.workspace }}/.cache/pip
+      PRE_COMMIT_HOME: ${{ github.workspace }}/.cache/pre-commit
     steps:
       - name: 自版控庫取出內容
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
-      - name: 安裝 pre-commit
-        run: pip3 install pre-commit
+      - name: Configure PyPI data cache to speed up continuous integration
+        uses: actions/cache@v3
+        with:
+          key: ${{ runner.os }}-pip
+          path: ${{ env.PIP_CACHE_DIR }}
+
+      - name: >-
+          Configure pre-commit data cache to speed up continuous integration
+        uses: actions/cache@v3
+        with:
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+          path: ${{ env.PRE_COMMIT_HOME }}
 
-      - name: 使用 pre-commit 檢查專案中的所有檔案
-        run: pre-commit run --all-files --color always
+      - name: Running static analysis program
+        run: |
+          sudo ./continuous-integration/do-static-analysis.install-system-deps.sh
+          ./continuous-integration/do-static-analysis.sh
 
-      - name: 傳送持續整合結果告警到 Telegram 頻道
+      - name: Send CI result notification to the Telegram channel
         uses: yanzay/[email protected]
         if: always()
         with:

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+# Release product and their build aritfacts
+#
+# References:
+#
+# * Workflow syntax for GitHub Actions - GitHub Docs
+#   https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
+#
+# Copyright 2023 林博仁(Buo-ren, Lin) <[email protected]>
+# SPDX-License-Identifier: CC-BY-SA-4.0
+name: Release product and their build aritfacts
+on:
+  push:
+    tags:
+      - v*.*.*
+
+jobs:
+  release:
+    name: Release product and their build aritfacts
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout content from the Git repository
+        uses: actions/checkout@v4
+
+      - name: Determine the project identifier
+        run: printf "project_id=${GITHUB_REPOSITORY##*/}\\n" >> $GITHUB_ENV
+
+      - name: Determine the name of the Git tag
+        run: printf "release_tag=${GITHUB_REF##*/}\\n" >> $GITHUB_ENV
+
+      - name: Determine the release version string
+        run: printf "release_version=${release_tag#v}\\n" >> $GITHUB_ENV
+
+      - name: Determine the release identifier
+        run: printf "release_id=${project_id}-${release_version}\\n" >> $GITHUB_ENV
+
+      - name: Generate the release archive
+        run: |-
+          sudo ./continuous-integration/generate-build-artifacts.install-system-deps.sh
+          ./continuous-integration/generate-build-artifacts.sh
+
+      - name: Generate the release description
+        run: ./continuous-integration/generate-release-description.sh
+
+      - name: Publish the release archive to the GitHub Releases
+        uses: softprops/[email protected]
+        with:
+          name: ${{ env.project_id }} ${{ env.release_version }}
+          files: |
+            ${{ env.release_id }}.tar*
+          body_path: .detailed_changes

.gitignore

@@ -38,6 +38,9 @@
 # https://reuse.software/
 !.reuse/
 
+# Do track GitLab CI configuration file
+!/.gitlab-ci.yml
+
 # Don't track common backup filename extensions
 *~
 *.bak*

.gitlab-ci.yml

@@ -7,8 +7,9 @@
 #
 # Copyright 2023 林博仁(Buo-ren, Lin) <[email protected]>
 # SPDX-License-Identifier: CC-BY-SA-4.0
-static-analysis:
+do-static-analysis:
   stage: test
+  needs: []
   image: ubuntu:22.04
   variables:
     PIP_CACHE_DIR: ${CI_PROJECT_DIR}/.cache/pip
@@ -21,4 +22,41 @@ static-analysis:
       - ${PRE_COMMIT_HOME}
 
   script:
+    - ./continuous-integration/do-static-analysis.install-system-deps.sh
     - ./continuous-integration/do-static-analysis.sh
+
+generate-build-artifacts:
+  stage: build
+  rules:
+    - if: $CI_COMMIT_TAG
+  needs: []
+  image: ubuntu:22.04
+  artifacts:
+    paths:
+      - ${CI_PROJECT_NAME}-*.tar*
+  script:
+    - ./continuous-integration/generate-build-artifacts.install-system-deps.sh
+    - ./continuous-integration/generate-build-artifacts.sh
+
+upload-release-assets:
+  stage: deploy
+  rules:
+    - if: $CI_COMMIT_TAG
+  needs:
+    - generate-build-artifacts
+  image: curlimages/curl:latest
+  script:
+    - ./continuous-integration/upload-gitlab-generic-packages.sh
+
+create-release:
+  stage: deploy
+  rules:
+    - if: $CI_COMMIT_TAG
+  needs:
+    - generate-build-artifacts
+    - upload-release-assets
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  script:
+    - apk add bash git
+    - ./continuous-integration/generate-release-description.sh
+    - ./continuous-integration/create-gitlab-release.sh

.pre-commit-config.yaml

@@ -8,8 +8,6 @@
 # Copyright 2021 林博仁(Buo-ren, Lin) <[email protected]>
 # SPDX-License-Identifier: CC-BY-SA-4.0
 
-exclude: '^continuous-integration/venv$'
-
 repos:
   # Some out-of-the-box hooks for pre-commit
   # https://github.com/pre-commit/pre-commit-hooks
@@ -44,13 +42,13 @@ repos:
   # Check REUSE compliance
   # https://reuse.software/
   - repo: https://github.com/fsfe/reuse-tool
-    rev: v0.12.1
+    rev: v1.0.0
     hooks:
       - id: reuse
 
   # Check YAML files
   # https://github.com/adrienverge/yamllint
   - repo: https://github.com/adrienverge/yamllint
-    rev: v1.32.0
+    rev: v1.30.0
     hooks:
       - id: yamllint

continuous-integration/create-gitlab-release.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+# Create GitLab project release
+#
+# Copyright 2023 林博仁(Buo-ren, Lin) <[email protected]>
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
+set \
+    -o errexit \
+    -o nounset
+
+if ! test -v CI_PROJECT_ID; then
+    printf \
+        'Error: This program should be run under a GitLab CI environment.\n' \
+        1>&2
+    exit 1
+fi
+
+printf \
+    'Info: Determining release version...\n'
+release_version="${CI_COMMIT_TAG#v}"
+
+# bash - How to get script directory in POSIX sh? - Stack Overflow
+# https://stackoverflow.com/questions/29832037/how-to-get-script-directory-in-posix-sh
+script_dir="$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd)"
+project_dir="${script_dir%/*}"
+
+printf \
+    'Info: Determining release details...\n'
+detailed_changes_file="${project_dir}/.detailed_changes"
+if ! test -e "${detailed_changes_file}"; then
+    printf \
+        'Error: The detailed changes file "%s" does not exist.\n' \
+        "${detailed_changes_file}" \
+        1>&2
+    exit 2
+fi
+
+release_cli_create_opts=(
+    --name "${CI_PROJECT_TITLE} ${release_version}"
+    --tag-name "${CI_COMMIT_TAG}"
+
+    # WORKAROUND: Absolute path is not accepted as file input
+    --description "${detailed_changes_file##*/}"
+)
+
+shopt -s nullglob
+for file in "${project_dir}/${CI_PROJECT_NAME}-"*; do
+    filename="${file##*/}"
+    package_registry_url="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/${CI_PROJECT_NAME}/${release_version}/${filename}"
+
+    release_cli_create_opts+=(
+        --assets-link "{\"name\": \"${filename}\", \"url\": \"${package_registry_url}\"}"
+    )
+done
+
+printf \
+    'Info: Creating the GitLab release...\n'
+if ! \
+    release-cli create \
+        "${release_cli_create_opts[@]}"; then
+    printf \
+        'Error: Unable to create the GitLab release.\n' \
+        1>&2
+    exit 2
+fi
+
+printf \
+    'Info: Operation completed without errors.\n'