Initial Integration of CI Pipeline into Main for Further Testing

.github/README.md

@@ -0,0 +1,43 @@
+# Mesh CI
+
+---
+
+## NOTES
+
+- To run the orchestrator to test on branches outside of main, run ```gh workflow run reporting_orchestrator.yml  --ref feature/ras-cicd```, replacing "feature/ras-cicd" whichever branch you wish to run the workflow against.
+- Super-Linter summary can only be added on pushes and PRs, not manual runs. Super-Linter is still running, you just need to dig into the workflow details to view useful results.
+
+---
+
+## Pipeline Flow
+
+The CI pipeline behaves as follows:
+
+1. run Prettier on web-related filetypes, as well as XML
+   a. Do not use prettier-plugin-kotlin, it is not maintained and errors regularly
+2. On push, run super-linter. For all possible cases, run autofix (this covers Kotlin)
+
+- This Section Needs updating
+
+---
+
+## General TODO
+
+### Ongoing
+
+- For all workflows, add current build summary as commit/pr comments
+- Add script to preview to change iFrame title and onscreen title + pass/fail indicator
+- For orchestrator
+  - determine how to allow multiple reusable workflows to share build cache
+  - add setting on manual run whether to commit anything/deploy to pages
+
+
+### Backlog
+
+- Break workflows out into multiple intelligently-grouped jobs for improved execution visibility
+- Add graceful error handling if specific preview reports cannot be generated
+- Add graceful error handling to note that coverage reporting can only be generated on PRs and pushes, not workflow dispatches
+- Research if it's possible to ask to run workflows on any push
+
+### Integration
+

.github/linters/.markdown-lint.yml

@@ -0,0 +1,7 @@
+---
+# MD013/line-length - Line length
+MD013:
+  # Number of characters, default is 80
+  line_length: 9999
+  # check code blocks?
+  code_blocks: false

.github/linters/.yaml-lint.yml

@@ -0,0 +1,53 @@
+---
+###########################################
+# These are the rules used for            #
+# linting all the yaml files in the stack #
+# NOTE:                                   #
+# You can disable line with:              #
+# # yamllint disable-line                 #
+###########################################
+rules:
+  braces:
+    level: warning
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: 1
+    max-spaces-inside-empty: 5
+  brackets:
+    level: warning
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: 1
+    max-spaces-inside-empty: 5
+  colons:
+    level: warning
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    level: warning
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1
+  comments: disable
+  comments-indentation: disable
+  document-end: disable
+  document-start: disable
+  empty-lines:
+    level: warning
+    max: 2
+    max-start: 0
+    max-end: 0
+  hyphens:
+    level: warning
+    max-spaces-after: 1
+  indentation:
+    level: warning
+    spaces: consistent
+    indent-sequences: true
+    check-multi-line-strings: false
+  key-duplicates: enable
+  line-length: disable
+  new-line-at-end-of-file: disable
+  new-lines:
+    type: unix
+  trailing-spaces: disable

.github/workflows/build_artifacts.yml

@@ -0,0 +1,77 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
+
+name: Build APKs
+run-name: ${{ github.event.inputs.custom_run_name || github.workflow }}
+
+on:
+  # run when called by another workflow
+  workflow_call:
+    inputs:
+      skip_commit:
+        description: "Skip committing reports"
+        required: false
+        type: boolean
+        default: false
+
+  # run on demand
+  workflow_dispatch:
+    inputs:
+      custom-run-name:
+        description: "Custom name for this Actions run"
+        required: false
+        type: string
+
+# cancel any previously-started, yet still active runs of this workflow on the same branch
+concurrency:
+  group: ${{ github.ref }}-Build APKs
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Notify User to Scroll
+        run: |
+          echo "## Scroll to the end of the page for artifacts :arrow_down:" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "---" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+
+      - name: Check Out Code
+        uses: actions/checkout@v6
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v5
+        with:
+          distribution: "temurin"
+          java-version: "17"
+
+      - name: Set Up Gradle
+        uses: gradle/actions/setup-gradle@v5
+        with:
+          add-job-summary: never
+
+      - name: Build with Gradle Wrapper
+        run: ./gradlew assemble # use assemble because build runs tests, even though a different part of the system handles that
+
+      - name: Upload App Debug APK
+        uses: actions/upload-artifact@v6
+        with:
+          name: app-debug-apk
+          path: app/build/outputs/apk/debug/app-debug.apk 
+          retention-days: 1 
+
+      - name: Upload App Release APK
+        uses: actions/upload-artifact@v6
+        with:
+          name: app-release-apk 
+          path: app/build/outputs/apk/release/app-release-unsigned.apk
+          retention-days: 1 

.github/workflows/build_documentation.yml

@@ -0,0 +1,78 @@
+name: Build Dokka Docs
+run-name: ${{ github.event.inputs.custom_run_name || github.workflow }}
+
+on:
+  # run when called by another workflow
+  workflow_call:
+    inputs:
+      skip_commit:
+        description: "Skip committing reports"
+        required: false
+        type: boolean
+        default: false
+
+  # run on demand
+  workflow_dispatch:
+    inputs:
+      custom-run-name:
+        description: "Custom name for this Actions run"
+        required: false
+        type: string
+
+# cancel any previously-started, yet still active runs of this workflow on the same branch
+concurrency:
+  group: ${{ github.ref }}-Build Dokka Docs
+  cancel-in-progress: true
+
+permissions: read-all
+
+# adapted from https://mskelton.medium.com/auto-formatting-code-using-prettier-and-github-actions-ed458f58b7df
+jobs:
+  call-dokka:
+    name: Call Dokka Html
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Check Out Code
+        uses: actions/checkout@v6
+
+      - name: Set up JDK
+        uses: actions/setup-java@v5
+        with:
+          distribution: "temurin"
+          java-version: "17"
+
+      - name: Set Up Gradle
+        uses: gradle/actions/setup-gradle@v5
+        with:
+          add-job-summary: never
+
+      - name: Generate Dokka Pages
+        run: ./gradlew dokkaGenerate
+        continue-on-error: true
+
+      - name: Configure Git Identity (if called individually)
+        if: ${{ inputs.skip_commit != true }}
+        run: |
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+
+      - name: Copy Documentation to Viewing Directory (if called individually)
+        if: ${{ inputs.skip_commit != true }}
+        run: |
+          mkdir ./build_reports/documentation
+          cp -r ./app/build/dokka/html/ ./build_reports/documentation
+          git add --force ./build_reports/
+          git commit -m "Relocate documentation for viewing"
+          git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload Documentation Artifact (if called by orchestrator)
+        if: ${{ inputs.skip_commit == true }}
+        uses: actions/upload-artifact@v6
+        with:
+          name: dokka_documentation_artifact
+          path: ./app/build/dokka/html
+          retention-days: 1

.github/workflows/call_gradle_lint.yml

@@ -0,0 +1,101 @@
+name: Lint Kotlin Code (Gradle Linter)
+run-name: ${{ github.event.inputs.custom_run_name || github.workflow }}
+
+on:
+  # run when called by another workflow
+  workflow_call:
+    inputs:
+      skip_commit:
+        description: "Skip committing reports"
+        required: false
+        type: boolean
+        default: false
+
+  # run on demand
+  workflow_dispatch:
+    inputs:
+      custom-run-name:
+        description: "Custom name for this Actions run"
+        required: false
+        type: string
+
+# cancel any previously-started, yet still active runs of this workflow on the same branch
+concurrency:
+  group: ${{ github.ref }}-Lint Kotlin Code (Gradle Linter)
+  cancel-in-progress: true
+
+permissions: read-all
+
+# adapted from https://mskelton.medium.com/auto-formatting-code-using-prettier-and-github-actions-ed458f58b7df
+jobs:
+  call-gradle-linter:
+    name: Call Gradle Linter
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Check Out Code
+        uses: actions/checkout@v6
+
+      - name: Set up JDK
+        uses: actions/setup-java@v5
+        with:
+          distribution: "temurin"
+          java-version: "17"
+
+      - name: Set Up Gradle
+        uses: gradle/actions/setup-gradle@v5
+        with:
+          add-job-summary: never
+
+      - name: Call Debug and Release Linters
+        # ostensibly, ./gradlew lint should run both, but in practice on my (Thalia Wood's), it only runs the Debug linter
+        run: |
+          set -o pipefail
+          output1=$(./gradlew lintDebug)
+          output2=$(./gradlew lintRelease)
+          echo "$output1"
+          echo "---"
+          echo "$output2"
+          if [[ (echo "$output1" | grep -Ezq " Task :app:compileDebugKotlin\nw: file:") || (echo "$output2" | grep -Ezq " Task :app:compileReleaseKotlin\nw: file:") ]]; then
+            echo "Linting warnings detected. View details at https://grey-box.github.io/Project-Mesh/ once the workflow is finished."
+            exit 1
+          else
+            echo "Linting returned clean"
+          fi
+        continue-on-error: true
+
+      - name: Configure Git Identity (if called individually)
+        if: ${{ inputs.skip_commit != true }}
+        run: |
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+
+      - name: Copy Linting Reports to Viewing Directory (if called individually)
+        if: ${{ inputs.skip_commit != true }}
+        run: |
+          mkdir ./build_reports/lint_results_debug
+          cp ./app/build/reports/lint-results-debug.html ./build_reports/lint_report_debug/lint_report_debug.html
+          mkdir ./build_reports/lint_results_release
+          cp ./app/build/reports/lint-results-release.html ./build_reports/lint_report_release/lint_report_release.html
+          git add --force ./build_reports/
+          git commit -m "Relocate linting report for viewing"
+          git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload Lint Debug Artifact (if called by orchestrator)
+        if: ${{ inputs.skip_commit == true }}
+        uses: actions/upload-artifact@v6
+        with:
+          name: lint_report_debug_artifact
+          path: ./app/build/reports/lint-results-debug.html
+          retention-days: 1
+
+      - name: Upload Lint Release Artifact (if called by orchestrator)
+        if: ${{ inputs.skip_commit == true }}
+        uses: actions/upload-artifact@v6
+        with:
+          name: lint_report_release_artifact
+          path: ./app/build/reports/lint-results-release.html
+          retention-days: 1