Versioning support (#27)

Author: zhiquanyeo

.github/workflows/firmware.yml

@@ -10,9 +10,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
+    - name: Set FIRMWARE_VERSION variable
+      run: |
+        FIRMWARE_VER=$(cat VERSION)
+        echo "FIRMWARE_VERSION=$FIRMWARE_VER" >> $GITHUB_ENV
+    - name: Set FIRMWARE_COMMIT_HASH variable
+      run: echo "FIRMWARE_COMMIT_SHA=$(git rev-parse --short "$GITHUB_SHA")" >> "$GITHUB_ENV"
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v3
       with:
         python-version: 3.8
     - name: Install dependencies
@@ -21,7 +27,9 @@ jobs:
         pip install platformio
     - name: Build
       run: pio run
-    - uses: actions/upload-artifact@v2
+    - name: Rename firmware
+      run: mv .pio/build/rpipicow/firmware.uf2 .pio/build/rpipicow/xrp-wpilib-firmware-${{ env.FIRMWARE_VERSION }}-${{ env.FIRMWARE_COMMIT_SHA }}.uf2
+    - uses: actions/upload-artifact@v3
       with:
-        name: xrp-wpilib-firmware.uf2
-        path: .pio/build/rpipicow/firmware.uf2
+        name: xrp-wpilib-firmware-${{ env.FIRMWARE_VERSION }}-${{ env.FIRMWARE_COMMIT_SHA }}
+        path: .pio/build/rpipicow/xrp-wpilib-firmware-*.uf2

VERSION

@@ -0,0 +1 @@
+0.5.1

extra_script.py

@@ -9,6 +9,14 @@
 resBuildDir = os.path.join(env.subst("$BUILD_DIR"), "resources", "build")
 resDir = os.path.join(env.subst("$PROJECT_DIR"), "resources")
 minifiedJsDir = os.path.join(env.subst("$BUILD_DIR"), "resources", "minifiedjs")
+versionReplaceDir = os.path.join(env.subst("$BUILD_DIR"), "resources", "versionReplace")
+
+# open the VERSION file
+versionFile = os.path.join(env.subst("$PROJECT_DIR"), "VERSION")
+version = "UNK"
+with open(versionFile, "r") as f:
+    version = f.read().strip()
+print("Version Info: ", version)
 
 print("Resource Dir: ", resDir)
 
@@ -24,6 +32,10 @@
     shutil.rmtree(minifiedJsDir)
 os.makedirs(minifiedJsDir)
 
+if os.path.exists(versionReplaceDir):
+    shutil.rmtree(versionReplaceDir)
+os.makedirs(versionReplaceDir)
+
 def genResource(inputFile):
     with open(inputFile, "rb") as f:
         data = f.read()
@@ -54,6 +66,21 @@ def minifyJs(inputFile):
 
     return outputFile
 
+def versionReplace(inputFile):
+    with open(inputFile, "r") as f:
+        data = f.read()
+
+    inputBase = os.path.basename(inputFile)
+    outputFile = os.path.join(versionReplaceDir, inputBase)
+
+    # find replacement
+    data = data.replace("%%%VERSION_REPLACE%%%", version)
+
+    with open(outputFile, "w") as f:
+        print(data, file=f)
+
+    return outputFile
+
 
 # Loop through everything in the resources folder
 # For each item, generate the resource cpp file
@@ -65,6 +92,8 @@ def minifyJs(inputFile):
             # minify JS files
             if len(fileExt) > 1 and (fileExt[-1]).lower() == ".js":
                 genResource(minifyJs(f))
+            elif filename == "index.html":
+                genResource(versionReplace(f))
             else:
                 genResource(f)
 

resources/index.html

@@ -23,5 +23,8 @@ <h4>XRP Configuration</h4>
             <input class="button-primary" id="saveButton" type="submit" value="Save">
         </form>
       </div>
+      <div class="row">
+          Firmware Version: %%%VERSION_REPLACE%%%
+      </div>
 </body>
 </html>