Merge pull request #2 from joshraphael/ci/template

Ci/template

Author: joshraphael

.github/workflows/test.yaml

@@ -0,0 +1,19 @@
+name: Test action template file
+
+on:
+  push:
+    branches:
+      - '*'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  template:
+    name: template
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check template is correct
+        run: bash ./scripts/check.sh

.gitignore

@@ -0,0 +1 @@
+playground/

Makefile

@@ -0,0 +1,8 @@
+template:
+	./scripts/template.sh > action.yml
+
+check:
+	./scripts/check.sh
+
+hooks:
+	./scripts/hooks.sh

action.yml

@@ -1,5 +1,5 @@
 name: RAScript Audit
-description: Compiles an RAScript for RetroAchievements development and performs an audit on the code.
+description: Compile and review a RAScript achievement logic file for Retro Achievements
 author: joshraphael
 
 inputs:
@@ -8,7 +8,7 @@ inputs:
     type: string
     required: true
   game-id:
-    description: "RetroAchievements game id"
+    description: "Retro Achievements game id"
     type: number
     required: true
   rascript:

scripts/check.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+export PLAYGROUND="playground"
+export GENERATED_FILE="${PLAYGROUND}/action2.yml"
+export GE
+
+rm -rf ${PLAYGROUND}
+mkdir -p ${PLAYGROUND}
+cp action.yml ${PLAYGROUND}
+./scripts/template.sh > ${GENERATED_FILE}
+
+if cmp -s ${PLAYGROUND}/action.yml ${GENERATED_FILE}; then
+  echo "The files are identical."
+  exit 0
+fi
+
+echo "The files are different."
+diff ${PLAYGROUND}/action.yml ${GENERATED_FILE}
+exit 1

scripts/hooks.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+export CHECK_SCRIPT="scripts/check.sh"
+export HOOKS_DIR=".git/hooks"
+export PRE_COMMIT_FILE="${HOOKS_DIR}/pre-commit"
+mkdir -p ${HOOKS_DIR}
+rm -rf ${PRE_COMMIT_FILE}
+cp ${CHECK_SCRIPT} ${PRE_COMMIT_FILE}

scripts/template.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+export CONTAINER_ID='$CONTAINER_ID'
+export RASCRIPT_AUDIT_IMG_VERSION="v0.0.4"
+
+cat templates/action.template.yml | envsubst

templates/action.template.yml

@@ -0,0 +1,59 @@
+name: RAScript Audit
+description: Compile and review a RAScript achievement logic file for Retro Achievements
+author: joshraphael
+
+inputs:
+  id:
+    description: "Unique identifier to prepend on the output file"
+    type: string
+    required: true
+  game-id:
+    description: "Retro Achievements game id"
+    type: number
+    required: true
+  rascript:
+    description: "The RAScript file name to compile"
+    type: string
+    required: true
+  report:
+    description: "Create a report of the audit"
+    type: boolean
+    required: false
+  severity:
+    description: "Level of severity to fail on"
+    type: choice
+    required: false
+    options: 
+      - info
+      - warn
+      - error
+
+branding:
+  color: blue
+  icon: award
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+    - name: pull image
+      if: ${{ 1 == 0 }} # this is a hack to pre-fetch the docker image to reduce the logs in the actual action
+      uses: docker://ghcr.io/joshraphael/rascript-audit-img:${RASCRIPT_AUDIT_IMG_VERSION}
+    - name: Run rascript-audit
+      shell: bash
+      run: |
+        docker container rm -f rascript-audit-img
+        mkdir -p container_home
+        docker run --name rascript-audit-img -e GAME_ID=${{ inputs.game-id }} -e RASCRIPT_FILE="${{ inputs.rascript }}" -e REPORT=${{ inputs.report }} -e SEVERITY=${{ inputs.severity }} --mount type=bind,src=.,dst=/app/rascript -i --entrypoint=/app/entry.sh ghcr.io/joshraphael/rascript-audit-img:${RASCRIPT_AUDIT_IMG_VERSION}
+        export CONTAINER_ID=$(docker ps -a --filter name=${{ inputs.name }} -q)
+        docker cp $CONTAINER_ID:/app/home.txt container_home/
+        docker cp $CONTAINER_ID:/app/copy.sh container_home/
+        GAME_ID=${{ inputs.game-id }} REPORT=${{ inputs.report }} bash container_home/copy.sh
+        rm -rf container_home/home.txt
+        rm -rf container_home/copy.sh
+    - name: Upload Audit
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ inputs.id }}-${{ inputs.game-id }}-audit
+        path: container_home/