CI/CD: Config and keep remote files (#988)

* Don't delete other files on remote machine

Previous behavior removed all files, except those excluded, from the remote directory

* Required for RedM natives update.

* Central config file for both native and compatgen

This allows us to easily change input and output file names throughout the whole native generation process.

.ci/config.sh

@@ -0,0 +1,4 @@
+# default config values for our scripts. May be overriden in scripts, e.g.: manual workflow dispatch
+CONFIG_UPLOAD_COMPAT_FILE="natives_global_client_compat"
+CONFIG_UPLOAD_NATIVES_FILE="natives"
+CONFIG_COMPAT_FROM_DATE="2023-01-01" #YYYY-MM-DD

.ci/run-compat

@@ -1,13 +1,16 @@
 #!/bin/bash
 
 # configuration
+ci_root="$(dirname "$0")"
+. "$ci_root"/config.sh
+
 GENERATOR_PATH="$1/compatgen.js"
-OUTPUT_FILE=${2:-"./out/natives_global_client_compat.lua"}
-INPUT_FILE=${3:-"./in/natives_global_client_compat.lua"}
+OUTPUT_FILE=${2:-"./out/$CONFIG_UPLOAD_COMPAT_FILE.lua"}
+INPUT_FILE=${3:-"./in/$CONFIG_UPLOAD_COMPAT_FILE.lua"}
 IGNORE_MISSING_INPUT=${4:-false}
 FORCE_UPDATE=${5:-false}
 USE_HISTORY=${6:-false}
-DAYS_SINCE_DATE=${7:-2023-01-01} #YYYY-MM-DD
+DAYS_SINCE_DATE=${7:-"$CONFIG_COMPAT_FROM_DATE"} #YYYY-MM-DD
 VERSION=${8:-2.0}
 
 # execution

.ci/run-deploy

@@ -7,6 +7,7 @@ ci_root="$(dirname "$0")"
 
 # include common script
 . "$ci_root"/common.sh
+. "$ci_root"/config.sh
 
 title "Building new documentation output...\n"
 
@@ -15,10 +16,10 @@ mkdir -p out
 # Native generation
 pushd "$BUILDER_ROOT"
 node index.js "$repo_root"
-cp -a natives_test.json "$repo_root/out/natives.json"
-node build-template.js lua > "$repo_root/out/natives.lua"
-node build-template.js reference > "$repo_root/out/natives.html"
+cp -a natives_test.json "$repo_root/out/$CONFIG_UPLOAD_NATIVES_FILE.json"
+node build-template.js lua > "$repo_root/out/$CONFIG_UPLOAD_NATIVES_FILE.lua"
+node build-template.js reference > "$repo_root/out/$CONFIG_UPLOAD_NATIVES_FILE.html"
 popd
 
 # Compatibility native generation
-"$ci_root"/run-compat "$BUILDER_ROOT" "./out/natives_global_client_compat.lua" "./in/natives_global_client_compat.lua"
+"$ci_root"/run-compat "$BUILDER_ROOT" "./out/$CONFIG_UPLOAD_COMPAT_FILE.lua" "./in/$CONFIG_UPLOAD_COMPAT_FILE.lua"

.github/workflows/deploy-repo.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
      - master
+  workflow_dispatch:
 
 jobs:
   deploy:
@@ -26,7 +27,8 @@ jobs:
           NATIVE_DEPLOY_URL: ${{ secrets.NATIVE_DEPLOY_URL }}
         run: |
           mkdir ./in
-          rsync -q --ignore-missing-args $NATIVE_DEPLOY_URL/natives_global_client_compat.lua ./in/natives_global_client_compat.lua
+          . ./.ci/config.sh
+          rsync -q --ignore-missing-args $NATIVE_DEPLOY_URL/$CONFIG_UPLOAD_COMPAT_FILE.lua ./in/$CONFIG_UPLOAD_COMPAT_FILE.lua
       - name: Run build
         run: |
           set -xe
@@ -36,5 +38,5 @@ jobs:
         env:
           NATIVE_DEPLOY_URL: ${{ secrets.NATIVE_DEPLOY_URL }}
         run: |
-          rsync -rq --delete-after --exclude=*compat.lua* ./out/ $NATIVE_DEPLOY_URL
+          rsync -rq --exclude=*compat.lua* ./out/ $NATIVE_DEPLOY_URL
           rsync -rqb --backup-dir=./ --suffix=.bak --include=*compat.lua --exclude=* ./out/ $NATIVE_DEPLOY_URL

.github/workflows/run-compatgen.yml

@@ -60,27 +60,32 @@ jobs:
         env:
           NATIVE_DEPLOY_URL: ${{ secrets.NATIVE_DEPLOY_URL }}
         run: |
+          . ./.ci/config.sh
           mkdir ./in
-          rsync -q --ignore-missing-args $NATIVE_DEPLOY_URL/natives_global_client_compat.lua ./in/natives_global_client_compat.lua
+          rsync -q --ignore-missing-args $NATIVE_DEPLOY_URL/$CONFIG_UPLOAD_COMPAT_FILE.lua ./in/$CONFIG_UPLOAD_COMPAT_FILE.lua
       
       - name: Run build
         shell: bash
         run: |
           set -xe
+          . ./.ci/config.sh
+          
           git fetch origin $GITHUB_REF_NAME --shallow-since=${{ inputs.since_date }}
           
           pushd ./
           . ./.ci/setup-builder
           popd
           
           mkdir -p out
-          [ ${{ inputs.no_input }} == false ] && INPUT_FILE="./in/natives_global_client_compat.lua" || INPUT_FILE="skip"
+          [ ${{ inputs.no_input }} == false ] && INPUT_FILE="./in/$CONFIG_UPLOAD_COMPAT_FILE..lua" || INPUT_FILE="skip"
           
-          ./.ci/run-compat $BUILDER_ROOT "./out/natives_global_client_compat.lua" "$INPUT_FILE" ${{ inputs.ignore_missing_input }} ${{ inputs.force }} ${{ inputs.use_history }} ${{ inputs.since_date }}
+          ./.ci/run-compat $BUILDER_ROOT "./out/$CONFIG_UPLOAD_COMPAT_FILE.lua" "$INPUT_FILE" ${{ inputs.ignore_missing_input }} ${{ inputs.force }} ${{ inputs.use_history }} ${{ inputs.since_date }}
           
       - name: Output -> Echo (stdout)
         if: inputs.output_action == 'Echo (stdout)'
-        run: cat ./out/natives_global_client_compat.lua
+        run: |
+          . ./.ci/config.sh
+          cat "./out/$CONFIG_UPLOAD_COMPAT_FILE.lua"
       
       - name: Output -> Artifact
         if: inputs.output_action == 'Artifact'
@@ -91,6 +96,4 @@ jobs:
 
       - name: Output -> Deploy
         if: inputs.output_action == 'Deploy to remote'
-        env:
-          NATIVE_DEPLOY_URL: ${{ secrets.NATIVE_DEPLOY_URL }}
-        run: rsync -rqb --backup-dir=./ --suffix=.bak --include=*compat.lua --exclude=* ./out/ $NATIVE_DEPLOY_URL
+        run: rsync -rqb --backup-dir=./ --suffix=.bak --include=*compat.lua --exclude=* ./out/ ${{secrets.NATIVE_DEPLOY_URL}}