Merge pull request #31 from jonpas/hemtt-ci-and-cleanup

Adapt to HEMTT v1, Rework CI and cleanup

.editorconfig

@@ -1,5 +1,12 @@
+root = true
+
 [*]
-indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
 indent_style = space
+indent_size = 2
 trim_trailing_whitespace = true
-insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,4 @@
+* text=auto
+*.png binary
+*.jpg binary
+*.paa binary

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: CI/Validate
+name: Build
 
 on:
   push:
@@ -11,29 +11,44 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout the source code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Validate SQF
       run: python3 tools/sqf_validator.py
     - name: Validate Config
       run: python3 tools/config_style_checker.py
-    - name: Validate Stringtables
-      run: python3 tools/stringtable_validator.py
-    - name: Validate Return Types
-      run: python3 tools/return_checker.py
     - name: Check for BOM
       uses: arma-actions/bom-check@master
+
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout the source code
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 1
-      - name: Build with HEMTT
-        uses: arma-actions/hemtt@master
-        with:
-          command: build --release --ci
-      - uses: actions/upload-artifact@v2
+    - name: Checkout the source code
+      uses: actions/checkout@v3
+    - name: Setup HEMTT
+      uses: arma-actions/hemtt@v1
+    - name: Run HEMTT release
+      run: hemtt release --no-archive
+    - name: Rename release folder
+      run: mv .hemttout/release .hemttout/@hatchet_framework
+    - uses: actions/upload-artifact@v3
+      with:
+        name: hatchet_framework-${{ github.sha }}-nobin
+        path: .hemttout/@*
+
+  publish:
+    needs: [build]
+    if: github.repository == 'Project-Hatchet/Interaction-Framework' && ! contains(github.event.head_commit.message, '[ci skip]') && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+      # Upload to Steam Workshop
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+      - uses: arma-actions/workshop-upload@v1
         with:
-          name: hatchet
-          path: releases/hatchet.zip
+          appId: '107410'
+          itemId: '2403978406' # Hatchet Framework - Test Version
+          contentPath: '.hemttout/@*'
+          changelog: 'See changelog on GitHub: https://github.com/Project-Hatchet/Interaction-Framework/commits'
+        env:
+          STEAM_USERNAME: ${{ secrets.STEAM_USERNAME }}
+          STEAM_PASSWORD: ${{ secrets.STEAM_PASSWORD }}

.github/workflows/release-drafter.yml

@@ -6,13 +6,11 @@ on:
       - main
 
 jobs:
-  update_release_draft:
+  draft:
     runs-on: ubuntu-latest
+    if: github.repository == 'Project-Hatchet/Interaction-Framework'
     steps:
-      # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5
-        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
-        with:
-          config-name: my-config.yml
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Release Drafter
+      uses: release-drafter/release-drafter@v5
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    tags:
+    - 'v*.*.*'
+
+jobs:
+  build_addon:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout the source code
+      uses: actions/checkout@v3
+    - name: Setup HEMTT
+      uses: arma-actions/hemtt@v1
+    - name: Run HEMTT release
+      run: hemtt release
+    - name: Rename release folder
+      run: mv .hemttout/release .hemttout/@hatchet_framework
+    - name: Upload to GitHub
+      uses: actions/action-gh-release@v1
+      with:
+        draft: true
+        files: releases/hatchet_framework_*.zip
+        name: 'Hatchet Framework ${{ github.ref_name }}'
+        tag_name: ${{ github.ref_name }}
+        target_commitish: ${{ github.sha }}
+    #- uses: arma-actions/workshop-upload@v1
+    #  with:
+    #    appId: '107410'
+    #    itemId: '' # Hatchet Framework - Stable Version
+    #    contentPath: '.hemttout/@*'
+    #    changelog: 'See changelog on GitHub: https://github.com/Project-Hatchet/Interaction-Framework/releases'
+    #  env:
+    #    STEAM_USERNAME: ${{ secrets.STEAM_USERNAME }}
+    #    STEAM_PASSWORD: ${{ secrets.STEAM_PASSWORD }}

.gitignore

@@ -1,8 +1,22 @@
+*.zip
+*.bak
+*.cache
+keys/*
+*.pbo
+texHeaders.bin
+*.swp
+*.swo
+*.biprivatekey
+Thumbs.db
 
-## Added by HEMTT
+## HEMTT
 releases/*
-*.biprivatekey
-keys/*
-.hemtt/local.toml
-addons/*.pbo
+hemtt
+hemtt.exe
+.hemttout
+####
+
+## SCONS
+release
+.sconsign.dblite
 ####

.hemtt/hooks/post_release/01_rename_zip.rhai

@@ -0,0 +1,11 @@
+let releases = HEMTT_RFS.join("releases");
+let name_nospaces = HEMTT.project().name();
+name_nospaces.replace(" ", "_");
+
+let src = releases.join(HEMTT.project().prefix() + "-" + HEMTT.project().version().to_string() + ".zip");
+let dst = releases.join(name_nospaces.to_lower() + "_" + HEMTT.project().version().to_string_short() + ".zip");
+
+print("Moving zip to " + dst);
+if !src.move(dst) {
+    warn("Failed to move " + src + " to " + dst + " (maybe --no-archive?)");
+}

.hemtt/project.toml

@@ -0,0 +1,35 @@
+name = "Hatchet Framework"
+prefix = "hatchet_vxf"
+author = "Project Hatchet"
+mainprefix = "z"
+
+[files]
+include = [
+  "mod.cpp",
+  "README.md",
+  "LICENSE",
+  "logo_vxf_ca.paa",
+  "meta.cpp",
+]
+
+[version]
+git_hash = 0
+
+[asc]
+enabled = true
+exclude = [
+  "/initsettings.sqf",
+  "/initkeybinds.sqf",
+  "/xeh_prep.sqf",
+]
+
+[hemtt.config]
+preset = "Hemtt"
+
+[hemtt.release]
+folder = "vxf_framework"
+
+[hemtt.launch]
+workshop = [
+  "450814997", # CBA_A3's Workshop ID
+]

SConstruct

@@ -17,7 +17,7 @@ def allFilesIn(path):
     return [s.replace("$", "$$") for s in glob.glob(path + '/**/*', recursive=True) if os.path.isfile(s)]
 
 def getSettings():
-    with open("build.json") as file:
+    with open("tools/build.json") as file:
         return json.load(file)
 
 def targetDefinition(target, description):
@@ -82,8 +82,8 @@ def commandsToCreateSymlink(pbo):
     return commands
 
 def buildPbo(settings,env, pbo):
-    env.Command(pbo.outputPath, allFilesIn(pbo.folder), 
-        f'"{addonBuilderPath()}" "{os.path.abspath(pbo.folder)}" "{os.path.abspath(settings["addonsFolder"])}" -clear -include=buildExtIncludes.txt')
+    env.Command(pbo.outputPath, allFilesIn(pbo.folder),
+        f'"{addonBuilderPath()}" "{os.path.abspath(pbo.folder)}" "{os.path.abspath(settings["addonsFolder"])}" -clear -include=tools\\buildExtIncludes.txt')
     targetDefinition(pbo.name, f"Build the {pbo.name} pbo.")
     return env.Alias(pbo.name, pbo.outputPath)
 
@@ -100,14 +100,14 @@ pbos = getPboInfo(settings)
 pboAliases = [buildPbo(settings,env, pbo) for pbo in pbos]
 
 env.Command("buildTools", [], Mkdir("buildTools"))
-    
+
 env.Command(r"buildTools\Natural Docs", [], [downloadNaturaldocs, Delete(r"buildTools\NaturalDocs.zip")])
 
 allPbos = env.Alias("all", pboAliases)
 targetDefinition("all", "Build all pbos.")
 
 buildDocs = env.Command(r"docs\index.html",
-    [s for s in allFilesIn(settings["addonsFolder"]) if s.endswith(".sqf")] + [r"buildTools\Natural Docs"], 
+    [s for s in allFilesIn(settings["addonsFolder"]) if s.endswith(".sqf")] + [r"buildTools\Natural Docs"],
     [Mkdir("docs"), r'"buildTools\Natural Docs\NaturalDocs.exe" naturaldocs'])
 env.AlwaysBuild(buildDocs)
 
@@ -130,4 +130,4 @@ except Exception as e:
     print(e)
     print("Error: Couldn't find arma 3, cannot make or remove symlinks")
 
-env.Default("all")
+env.Default("all")