Develop

.github/workflows/conv-pull-requests.yml

@@ -9,10 +9,11 @@ permissions:
   pull-requests: write
 
 jobs:
-  hqprs:
+  cpr:
     runs-on: ubuntu-latest
     steps:
       - name: conventional-pr
         uses: Namchee/[email protected]
         with:
           access_token: ${{ secrets.GITHUB_TOKEN }}
+          ignored_users: snyk-bot

.github/workflows/release.yml

@@ -1,9 +1,7 @@
 name: release
 
 # TODO
-# - Get AssemblyName, TargetFramework (TFM), RuntimeIdentifier (RID) from Directory.Build.props, *.csproj
-# - Overwrite `$env:RID and `$env:TFM with build props, allowing workflows to be driven by the project(s)
-# - support multiple ASSEMBLYNAME parameters for matrices
+# allow workflows to be driven by the project(s)
 
 on:
   push:
@@ -18,8 +16,6 @@ jobs:
     name: Build
     runs-on: windows-latest
     env:
-      RID: "win-x86"
-      TFM: "net5.0-windows"
       ASSEMBLYNAME: "HXE"
       PROJPATH: "./src/HXE.csproj"
 
@@ -40,7 +36,7 @@ jobs:
     # Authenticates packages to push to GPR
     - uses: actions/[email protected]
       with:
-        dotnet-version: "6.0.x" # SDK Version to use.
+        dotnet-version: "6.0.x"
         include-prerelease: true
 
     - name: Add GitHub Package Repository
@@ -53,15 +49,15 @@ jobs:
     # BUILD
     ################
     - name: dotnet-publish
-      run: dotnet publish $env:CSPROJ_RELPATH -c Release --no-self-contained -p:ContinuousIntegrationBuild=true
+      run: dotnet publish ${{ env.PROJPATH }} -c Release -p:ContinuousIntegrationBuild=true
 
-    # required variables: TargetFramework, RuntimeIdentifier, GitVersion_FullSemVer
+    # required variables: GitVersion_FullSemVer
     - name: Compress-PublishArtifacts
       run: |
-        $publishPath = Resolve-Path ".\bin\Release\$env:TFM\$env:RID\publish";
-        $archiveName = "$env:ASSEMBLYNAME.$env:TFM-$env:RID.$env:GitVersion_FullSemVer.zip";
+        $publishPath = Resolve-Path ".\bin\Release\**\publish";
+        $archiveName = "$env:ASSEMBLYNAME.$env:GitVersion_FullSemVer.zip";
         Set-Location $publishPath;
-        Compress-Archive -Path $publishPath -DestinationPath $archiveName -CompressionLevel Optimal;
+        Compress-Archive -Path $publishPath -DestinationPath ${{ github.workspace }}\bin\Release\publish\$archiveName -CompressionLevel Optimal;
 
     ################
     # RELEASE
@@ -77,7 +73,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: publish-artifacts
-        path: bin/Release/${{ env.TFM }}/${{ env.RID }}/publish
+        path: bin/Release/publish
 
     - name: Publish to GitHub Packages
       working-directory: bin/Release

.husky/commit-msg

@@ -1,4 +1,2 @@
 #!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx --no-install commitlint --edit 
+npx --no -- commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"

.releaserc.yaml

@@ -28,7 +28,7 @@
     ['@semantic-release/github',
       {
         "assets": [
-          {"path": "bin/release/win-x64/publish"}
+          {"path": "bin/release/publish"}
         ]
       }
     ]

.vscode/launch.json

@@ -9,8 +9,9 @@
             "type": "coreclr",
             "request": "launch",
             "preLaunchTask": "build",
-            "program": "${workspaceFolder}/bin/Debug/win-x64/HXE.dll",
-            "args": ["--test"],
+            // If you have changed target frameworks, make sure to update the program path.
+            "program": "${workspaceFolder/bin/Debug/net462/HXE.dll",
+            "args": [],
             "cwd": "${workspaceFolder}/src",
             // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
             "console": "internalConsole",

.vscode/settings.json

@@ -15,5 +15,18 @@
         "conv-pr", // Conventional Pull Request config
         "commitizen",
         "pull-requests" // pull requests workflow
-    ]
+    ],
+    "markdownlint.config": {
+        "MD028": false,
+        "MD025": {
+            "front_matter_title": ""
+        }
+    },
+    "cSpell.words": [
+        "haloce"
+    ],
+    "omnisharp.useModernNet": true,
+    "omnisharp.enableRoslynAnalyzers": true,
+    "omnisharp.enableImportCompletion": true,
+    "omnisharp.organizeImportsOnFormat": true
 }

.vscode/tasks.json

@@ -32,9 +32,8 @@
             "args": [
                 "watch",
                 "run",
-                "${workspaceFolder}/src/HXE.csproj",
-                "/property:GenerateFullPaths=true",
-                "/consoleloggerparameters:NoSummary"
+                "--project",
+                "${workspaceFolder}/src/HXE.csproj"
             ],
             "problemMatcher": "$msCompile"
         }

README.md

@@ -5,7 +5,6 @@
     </p>
 </html>
 
-[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)
 [![Codecov](https://img.shields.io/codecov/c/github/HaloSPV3/HXE.svg?style=flat-square)](https://codecov.io/gh/HaloSPV3/HXE)
 
@@ -48,3 +47,19 @@ The USAGE document goes into detail on how to use HXE. In a nutshell:
 
     # configure the kernel
     .\hxe.exe -config
+
+# Requirements
+
+## Operating System
+
+| Minimum                                  | Recommended
+| ---------------------------------------- | -----------
+| Windows 7 SP1 32-bit (w/ addl. software) | Windows 10 64-bit
+
+## Note: Upgrading To Windows 10
+
+Using the [Windows Installation Media Creation Tool](https://www.microsoft.com/en-us/software-download/windows10?36261b60-2f68-4336-abe2-4b00f210b6aa=True), you can still upgrade to Windows 10 with your Windows 7/8/8.1 license.
+HOWEVER...
+
+- If your hardware distributor does not make Windows 10 drivers for your hardware, you may have a worse Windows 10 experience than expected.
+- Some drivers made for earlier Windows releases may work on Windows 10; some won't. You won't know until you try.