Enhance: RN version alignment & basic specifications

.github/workflows/msbuild.yml

@@ -1,46 +1,25 @@
 name: MSBuild
 
 on:
-  push:
-    branches: [ "master" ]
   pull_request:
-    branches: [ "master" ]
+    branches:
+      - "**"
+    types:
+      - opened
+      - synchronize
+      - reopened
+    paths-ignore:
+      - 'image/**'
+      - 'docs/**'
+      - '**/*.md'
+  workflow_dispatch:
 
 permissions:
   contents: read
 
 jobs:
-  build:
-    runs-on: windows-2022
-
-    strategy:
-      matrix:
-        configuration: [ Release ]
-
-    env:
-      SOLUTION_FILE_PATH: .
-      BUILD_CONFIGURATION: ${{ matrix.configuration }}
-
-    steps:
-      - name: Checkout repository (with submodules)
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Add MSBuild to PATH
-        uses: microsoft/setup-msbuild@v1.0.2
-
-      - name: Restore NuGet packages
-        run: nuget restore ${{ env.SOLUTION_FILE_PATH }}
-
-      - name: Build ${{ matrix.configuration }}
-        run: msbuild /m /p:Configuration=${{ env.BUILD_CONFIGURATION }} ${{ env.SOLUTION_FILE_PATH }} 
-
-      - name: Upload ${{ matrix.configuration }} Artifacts
-        if: ${{ success() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: FA2sp_${{ matrix.configuration }}_${{ github.sha }}
-          path: |
-            ${{ env.SOLUTION_FILE_PATH }}/${{ env.BUILD_CONFIGURATION }}/FA2sp.dll
-            ${{ env.SOLUTION_FILE_PATH }}/${{ env.BUILD_CONFIGURATION }}/FA2sp.pdb
+  verify:
+    uses: ./.github/workflows/reusable-build-and-test.yml
+    with:
+      configuration: Release
+      run_tests: true

.github/workflows/release.yml

@@ -0,0 +1,138 @@
+name: Release
+
+permissions:
+  contents: write
+
+on:
+  pull_request:
+    branches:
+      - "master"
+    types:
+      - closed
+    paths-ignore:
+      - 'image/**'
+      - 'docs/**'
+      - '**/*.md'
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: 'Custom Release Tag (leave empty to use auto-version)'
+        required: false
+        default: ''
+        type: string
+      prerelease:
+        description: 'Is Pre-release'
+        required: false
+        default: false
+        type: boolean
+
+env:
+  VERSION_MAJOR: 1
+  VERSION_MINOR: 6
+  VERSION_PREFIX: "v"
+
+jobs:
+  build-and-test:
+    if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true)
+    uses: ./.github/workflows/reusable-build-and-test.yml
+    with:
+      configuration: Release
+      run_tests: true
+
+  prepare-version:
+    needs: build-and-test
+    if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true)
+    runs-on: windows-2022
+    outputs:
+      release_tag: ${{ steps.determine_version.outputs.release_tag }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Generate Build Number
+        if: ${{ !inputs.tag_name }}
+        id: buildnumber
+        uses: onyxmueller/build-tag-number@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          prefix: auto-version-${{ env.VERSION_MAJOR }}.${{ env.VERSION_MINOR }}
+
+      - name: Determine Release Tag
+        id: determine_version
+        shell: pwsh
+        run: |
+          $customTag = "${{ inputs.tag_name }}"
+          if (-not [string]::IsNullOrWhiteSpace($customTag)) {
+              $tag = $customTag
+          } else {
+              $buildNum = [int]"${{ steps.buildnumber.outputs.build_number }}"
+              $revision = $buildNum - 1
+              $tag = "${{ env.VERSION_PREFIX }}${{ env.VERSION_MAJOR }}.${{ env.VERSION_MINOR }}.$revision"
+          }
+          Add-Content -Path $env:GITHUB_OUTPUT -Value "release_tag=$tag" -Encoding utf8
+          Write-Host "Determined Release Tag: $tag"
+
+  package:
+    needs: [build-and-test, prepare-version]
+    if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true)
+    runs-on: windows-2022
+    strategy:
+      matrix:
+        target: [YR, MO, RN]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Download Build Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: FA2sp_Release_${{ github.sha }}
+          path: bin_output
+
+      - name: Package Target (${{ matrix.target }})
+        shell: pwsh
+        run: |
+          ./Scripts/PackageRelease.ps1 -Target ${{ matrix.target }} -Version ${{ needs.prepare-version.outputs.release_tag }} -BinDir bin_output -OutputDir .
+          Add-Content -Path $env:GITHUB_ENV -Value "PACKAGE_NAME=FA2sp-${{ matrix.target }}-${{ needs.prepare-version.outputs.release_tag }}.zip" -Encoding utf8
+
+      - name: Upload Target Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-pkg-${{ matrix.target }}
+          path: ${{ env.PACKAGE_NAME }}
+          retention-days: 1
+
+  publish-release:
+    needs: [prepare-version, package]
+    if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true)
+    runs-on: windows-2022
+    steps:
+      - name: Download all release target packages
+        uses: actions/download-artifact@v4
+        with:
+          pattern: release-pkg-*
+          merge-multiple: true
+          path: release_assets
+
+      - name: Download Build Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: FA2sp_Release_${{ github.sha }}
+          path: bin_output
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ needs.prepare-version.outputs.release_tag }}
+          name: FA2sp ${{ needs.prepare-version.outputs.release_tag }}
+          files: |
+            release_assets/*.zip
+            bin_output/FA2sp.dll
+            bin_output/FA2sp.pdb
+          target_commitish: ${{ github.sha }}
+          prerelease: ${{ inputs.prerelease || false }}
+          generate_release_notes: true

.github/workflows/reusable-build-and-test.yml

@@ -0,0 +1,82 @@
+name: Reusable Build and Test
+
+on:
+  workflow_call:
+    inputs:
+      configuration:
+        description: 'Build Configuration (e.g. Release)'
+        required: false
+        default: 'Release'
+        type: string
+      run_tests:
+        description: 'Whether to run Unit Tests'
+        required: false
+        default: true
+        type: boolean
+    outputs:
+      artifact_name:
+        description: 'Name of the uploaded binary artifact'
+        value: ${{ jobs.build-and-test.outputs.artifact_name }}
+
+jobs:
+  build-and-test:
+    runs-on: windows-2022
+    env:
+      SOLUTION_FILE_PATH: FA2sp.sln
+      CONFIGURATION: ${{ inputs.configuration }}
+    outputs:
+      artifact_name: FA2sp_${{ inputs.configuration }}_${{ github.sha }}
+
+    steps:
+      - name: Checkout repository (with submodules)
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          submodules: recursive
+          lfs: true
+
+      - name: Add MSBuild to PATH
+        uses: microsoft/setup-msbuild@v1.0.2
+
+      - name: Restore NuGet packages
+        run: nuget restore ${{ env.SOLUTION_FILE_PATH }}
+
+      - name: Build Program and UT (MSVC)
+        run: msbuild /m /p:Configuration="${{ env.CONFIGURATION }}" /p:Platform=x86 ${{ env.SOLUTION_FILE_PATH }}
+
+      - name: Copy binaries to Supplementary
+        shell: pwsh
+        run: |
+          if (Test-Path "${{ env.CONFIGURATION }}/FA2sp.dll") {
+              Copy-Item -Force "${{ env.CONFIGURATION }}/FA2sp.dll" "Supplementary/FA2sp.dll"
+          }
+          if (Test-Path "${{ env.CONFIGURATION }}/FA2sp.UnitTest.dll") {
+              Copy-Item -Force "${{ env.CONFIGURATION }}/FA2sp.UnitTest.dll" "Supplementary/FA2sp.UnitTest.dll"
+          }
+
+      - name: do UT
+        if: inputs.run_tests
+        shell: cmd
+        run: |
+          call Scripts\RunUnitTest.bat
+
+      - name: Upload UT Results
+        if: always() && inputs.run_tests
+        uses: actions/upload-artifact@v4
+        with:
+          name: FA2sp-UT-Results-${{ github.run_number }}
+          path: |
+            Supplementary/UnitTest.log
+            Supplementary/UnitTest.xml
+            Supplementary/syringe.log
+          retention-days: 7
+
+      - name: Upload Build Artifacts
+        if: success()
+        uses: actions/upload-artifact@v4
+        with:
+          name: FA2sp_${{ env.CONFIGURATION }}_${{ github.sha }}
+          path: |
+            ${{ env.CONFIGURATION }}/FA2sp.dll
+            ${{ env.CONFIGURATION }}/FA2sp.pdb
+          retention-days: 7

.gitignore

@@ -44,3 +44,15 @@ MFC42
 !Debug/Scintilla.lib
 /ida_mapping
 /migration
+
+/FA2sp.UnitTest/Debug/*
+/FA2sp.UnitTest/Release/*
+/FA2sp.UnitTest/FA2sp.UnitTest/*
+
+Supplementary/FA2sp.UnitTest.dll
+Supplementary/FA2sp.dll
+Supplementary/*.log
+Supplementary/*.txt
+Supplementary/UnitTest.xml
+dist/
+bin_output/

.gitmodules

@@ -9,4 +9,7 @@
 	url = https://github.com/ScintillaOrg/lexilla
 [submodule "scintilla"]
 	path = scintilla
-	url = https://github.com/mirror/scintilla
+	url = https://github.com/mirror/scintilla
+[submodule "googletest"]
+	path = googletest
+	url = https://github.com/google/googletest.git

Claude.md

@@ -0,0 +1,5 @@
+# Instructions for Claude
+
+Must read [agents.md](agents.md).
+
+Always adhere strictly to the project rules, test verification mandates, and git constraints specified in [agents.md](agents.md).

Codex.md

@@ -0,0 +1,5 @@
+# Instructions for Codex
+
+Must read [agents.md](agents.md).
+
+Always adhere strictly to the project rules, test verification mandates, and git constraints specified in [agents.md](agents.md).