Add docs, ci, and scripts

2026-07-27 12:48:20 -07:00 · 2024-09-07 23:19:53 +02:00
parent 487b20c2f5
commit ec3214bbfe
5 changed files with 113 additions and 0 deletions
@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        target: [win-x86,win-x64,win-arm64]
+        include:
+          - target: win-x86
+            platform: win
+            architecture: x86
+          - target: win-x64
+            platform: win
+            architecture: x64
+          - target: win-arm64
+            platform: win
+            architecture: arm64
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.1.1
+
+      - name: Install .NET SDK
+        uses: actions/setup-dotnet@v4.0.0
+        with:
+          dotnet-version: "8.0.x"
+
+      - name: Add MSBuild to PATH
+        uses: microsoft/setup-msbuild@v1.3.1
+
+      - name: Build utilities
+        shell: pwsh
+        run: |
+          msbuild /m /t:restore,ffu2vhdx:publish /p:Platform=${{ matrix.architecture }} /p:RuntimeIdentifier=${{ matrix.platform }}-${{ matrix.architecture }} /p:PublishDir=${{ github.workspace }}/artifacts/${{ matrix.platform }}-${{ matrix.architecture }} /p:PublishSingleFile=true /p:PublishTrimmed=false /p:Configuration=Release Ffu2Vhdx.sln
+
+      - name: Create PDB Output Directory
+        shell: pwsh
+        run: |
+          mkdir ${{ github.workspace }}\artifacts\${{ matrix.platform }}-${{ matrix.architecture }}\PDBs
+
+      - name: Move PDBs
+        shell: pwsh
+        run: |
+          move ${{ github.workspace }}\artifacts\${{ matrix.platform }}-${{ matrix.architecture }}\*.pdb ${{ github.workspace }}\artifacts\${{ matrix.platform }}-${{ matrix.architecture }}\PDBs\
+
+      - name: Upload artifact (Binaries)
+        uses: actions/upload-artifact@v3.1.3
+        with:
+          name: ${{ matrix.platform }}-${{ matrix.architecture }}-binaries
+          path: ${{ github.workspace }}/artifacts/${{ matrix.platform }}-${{ matrix.architecture }}
+
+      - name: Upload artifact (Symbols)
+        uses: actions/upload-artifact@v3.1.3
+        with:
+          name: ${{ matrix.platform }}-${{ matrix.architecture }}-symbols
+          path: ${{ github.workspace }}/artifacts/${{ matrix.platform }}-${{ matrix.architecture }}\PDBs
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, Gustave Monce - gus33000.me - @gus33000
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
@@ -0,0 +1,3 @@
+@echo off
+
+msbuild /m /t:restore,ffu2vhdx:publish /p:Platform=arm64 /p:RuntimeIdentifier=win-arm64 /p:PublishDir="%CD%\publish\artifacts\win-arm64\CLI" /p:PublishSingleFile=true /p:PublishTrimmed=false /p:Configuration=Release Ffu2Vhdx.sln
@@ -0,0 +1,3 @@
+@echo off
+
+msbuild /m /t:restore,ffu2vhdx:publish /p:Platform=x64 /p:RuntimeIdentifier=win-x64 /p:PublishDir="%CD%\publish\artifacts\win-x64\CLI" /p:PublishSingleFile=true /p:PublishTrimmed=false /p:Configuration=Release Ffu2Vhdx.sln
@@ -0,0 +1,23 @@
+# Ffu2Vhdx - Converts any FFU into VHDX file(s)
+
+## Copyright
+
+Copyright (c) 2024, Gustave Monce - gus33000.me - @gus33000
+
+This software is released under the MIT license, for more information please see LICENSE.md
+
+## Description
+
+This tool enables converting Full Flash Update files (FFUs) into VHDX file(s).
+
+It notably supports every known FFU file format to date, that is:
+
+- Version 1
+- Version 1.1 (With added compression support)
+- Version 2 (With added multi store support)
+
+For Version 1 FFUs, the tool will create only one VHDX file.
+
+For Version 1.1 FFUs, conversion is only possible currently on Windows hosts and the tool will create only one VHDX file.
+
+For Version 2 FFUs, the tool will create more than one VHDX File.