u

Author: Alex2772

.github/workflows/build.yml

@@ -26,9 +26,8 @@ jobs:
         os: [windows-latest, ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: true
+      - name: Fetch sources
+        uses: actions/checkout@v4
 
       # Cache AUI boot directory
       - name: Cache AUI.BOOT deps
@@ -98,63 +97,39 @@ jobs:
           name: ${{ matrix.os }}
 
 
-  release:
+  release-draft:
     runs-on: ubuntu-latest
     permissions: write-all
-    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
-    name: "Create release page"
+    if: github.event_name != 'pull_request'
+    needs: [ build-desktop ]
+    name: "Release draft"
     steps:
-      - name: Retrieve version
-        if: ${{ contains(github.ref, 'tags/v') }}
-        run: |
-          echo "TAG_NAME=${{ github.ref }} " >> $GITHUB_ENV
-          echo "RELEASE_NAME=${{ github.ref }} " >> $GITHUB_ENV
+      - name: Fetch sources
+        uses: actions/checkout@v4
 
-      - name: Output version
-        id: version
+      - name: Extract version
+        run: |
+          VERSION=$(grep -Po '[0-9\.]+ (?=# CI_PROJECT_VERSION)' CMakeLists.txt)
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          echo "VERSION = $VERSION"
+          
+      # Remove old release drafts
+      - name: Remove Old Release Drafts
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          echo "ref=$TAG_NAME" >> $GITHUB_OUTPUT
+          gh api repos/{owner}/{repo}/releases \
+            --jq '.[] | select(.draft == true) | .id' \
+            | xargs -I '{}' gh api -X DELETE repos/{owner}/{repo}/releases/{} 
 
-      - name: Create Release
-        id: create_release
-        uses: actions/[email protected]
+      - name: Create Release Draft
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ env.TAG_NAME }}
-          release_name: ${{ env.RELEASE_NAME }}
-          draft: false
-          prerelease: true
+        run: |
+          gh release create "v${{ env.VERSION }}" \
+            --draft \
+            --title "v${{ env.VERSION }}"
+
     outputs:
       upload_url: ${{ steps.create_release.outputs.upload_url }}
       ref: ${{ steps.version.outputs.ref }}
-
-  publish:
-    name: Publish ${{ matrix.os }}
-    runs-on: ubuntu-latest
-    needs: [build-desktop, release]
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [windows-latest, ubuntu-latest]
-
-    steps:
-      - name: Download artifact
-        uses: actions/download-artifact@v4
-        with:
-          path: ./
-          name: ${{ matrix.os }}
-
-      - id: getfilename
-        run: echo "::set-output name=file::$(ls *)"
-
-      - name: Upload to Release
-        id: upload_to_release
-        uses: actions/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.release.outputs.upload_url }}
-          asset_path: ${{ steps.getfilename.outputs.file }}
-          asset_name: ${{ steps.getfilename.outputs.file }}
-          asset_content_type: application/x-gtar

.github/workflows/code-quality.yml

@@ -1,17 +1,13 @@
 name: Code Quality
 
 on:
-  push:
-    branches:
-      - master
   pull_request:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
 env:
-  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
   GIT_SUBMODULE_STRATEGY: recursive
 
 permissions:

CMakeLists.txt

@@ -1,6 +1,8 @@
 # Standard routine
 cmake_minimum_required(VERSION 3.16)
-project(aui_app VERSION 0.0.1)
+project(aui_app
+        VERSION 0.0.1 # CI_PROJECT_VERSION
+    )
 
 option(BUILD_SHARED_LIBS "Build shared libs" OFF)
 

README.md

@@ -9,12 +9,17 @@ project.
 The main goal of this template is to speed up the setup phase of application development for both new and experienced
 developers by preconfiguring the project scaffold and CI set up on GitHub.
 
+This template features:
+- Building, testing, code quality checking and releasing with [GitHub Actions][gh:actions]
+- Application auto updating (Windows only)
+- AUI assets
+- Tests
+
 # Getting Started
 
 It is worth mentioning the benefits of using GitHub Templates. By created a new project using a template, you start with
 no history or reference to this repository.
 
-
 # Continuous Integration
 
 In this project, continuous integration relies on [GitHub Actions][gh:actions], a set of workflows that enable
@@ -23,12 +28,21 @@ automation of building, testing and releasing process.
 In the `.github/workflows` directory, you can find definitions for the following GitHub Actions workflows:
 - [Build](.github/workflows/build.yml)
   - Triggered on `push` and `pull_request` events.
+  - Builds the project for the supported platforms.
+  - Runs Tests.
+  - Generates installable packages.
+  - Prepares a draft release of the GitHub Releases page for manual review.
 - [Code Quality](.github/workflows/code-quality.yml)
-  - Triggered on `push` and `pull_request` events.
+  - Triggered on `pull_request` events.
   - Performs `clang-tidy` checks (static analysis) and generates nice summary with `.github/tidy-summary.py`.
   - Performs `valgrind` checks on tests (dynamic analysis).
 
 
 # Code Quality and Formatting
 
 The template includes `.clang-format` and `.clang-tidy`, the latter is used for code quality checks.
+
+# Release Process
+
+To create a release, simply push an update to version in `CMakeLists.txt`. Pipeline will create a GitHub Release Draft
+for you. After release draft is created, perform manual review and submit release.