update actions to use ubuntu 20.04 & added getVersions automation so the wiki is updated automatically

grahambrown11 · grahambrown11 · commit 9e4238733765 · 2021-12-30T10:43:51.000+02:00
diff --git a/.github/workflows/ari-apis.yml b/.github/workflows/ari-apis.yml
@@ -1,4 +1,4 @@
-name: ARI4Java ARI APIs
+name: ARI4Java ARI APIs PR
 
 on:
   schedule:
@@ -7,16 +7,16 @@ on:
 
 jobs:
   getApis:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     steps:
       - uses: actions/checkout@v2
 
-      - name: Grant execute permission for getApis
-        run: chmod +x codegen/getApis.sh
-
       - name: Execute getApis
-        run: cd codegen && ./getApis.sh
+        run: |
+          cd codegen
+          chmod +x getApis.sh
+          ./getApis.sh
 
       - name: Create Pull Request
         id: cpr
diff --git a/.github/workflows/ari-versions.yml b/.github/workflows/ari-versions.yml
@@ -0,0 +1,33 @@
+name: ARI4Java ARI Versions Wiki Update
+
+on:
+  schedule:
+    - cron:  '0 10 * * SAT'
+  workflow_dispatch:
+
+jobs:
+  getApis:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout Project
+        uses: actions/checkout@v2
+      - name: Checkout Wiki
+        uses: actions/checkout@v2
+        with:
+          repository: ${{github.repository}}.wiki
+          path: codegen/tmp/wiki
+
+      - name: Execute getVersions
+        run: |
+          cd codegen
+          chmod +x getVersions.sh
+          ./getVersions.sh
+
+      - name: Push Wiki
+        run: |
+          cd codegen/tmp/wiki
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add .
+          git diff-index --quiet HEAD || git commit -m "Update Versions" && git push
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -12,7 +12,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     steps:
     - uses: actions/checkout@v2
diff --git a/codegen/getVersions.sh b/codegen/getVersions.sh
@@ -2,10 +2,24 @@
 
 START_DIR=`pwd`
 
-cd tmp/asterisk
+if [ ! -d "tmp/wiki" ]
+then
+  mkdir -p ${START_DIR}/tmp/wiki
+fi
 
-echo "| Asterisk | ARI |" > ${START_DIR}/versions.md
-echo "| :-- | :-- |" >> ${START_DIR}/versions.md
+if [ ! -d "tmp/asterisk" ]
+then
+  mkdir tmp
+  cd tmp
+  git clone "https://gerrit.asterisk.org/asterisk"
+  cd asterisk
+else
+  cd tmp/asterisk
+  git checkout master --force
+  git pull origin
+fi
+
+cat ${START_DIR}/versions-template.md > ${START_DIR}/tmp/wiki/Asterisk-Version-to-ARI-Version.md
 
 git show-ref --tags | while read tags
 do
@@ -21,7 +35,7 @@ do
   if [ -f "rest-api/resources.json" ]; then
     VER=`cat rest-api/resources.json | jq -r '.apiVersion'`
     echo ${VER}
-    echo "| ${array[1]:10} | ${VER} |" >> ${START_DIR}/versions.md
+    echo "| ${array[1]:10} | ${VER} |" >> ${START_DIR}/tmp/wiki/Asterisk-Version-to-ARI-Version.md
   fi
 done
 
diff --git a/codegen/versions-template.md b/codegen/versions-template.md
@@ -0,0 +1,10 @@
+## ARI Versions
+
+Within the Asterisk project ARI is versioned, these version numbers are not the same as the Asterisk version and also unrelated to ARI4Java's version.
+It is important to note the version of Asterisk you are running, so you can instantiate the library using the correct version.
+While using `AriVersion.IM_FEELING_LUCKY` tries to determine the correct version, it is recommended to rather specify a version for application stability. Generally it is safe to use an older version of ARI on a new Asterisk, but not the other way around.
+
+The table below is built up using the git tags to link the Asterisk version to the corresponding ARI version:
+
+| Asterisk | ARI |
+| :-- | :-- |
