TidyPlanCI.yml

# What initially started as the 'superlinter.yml' example workflow has evolved into this, 
# automated integration of our project with codebase-specific testing.

name: TidyPlan Automated CI

# Run this workflow every time a new commit is pushed to the repository
on: [push, pull_request]

jobs:
  build:
    # Set the type of machine to run on
    name: Test Code Base
    runs-on: ubuntu-latest
    steps:
      # Checks out a copy of the repository on a GitHub-hosted ubuntu virtual machine
      - name: Checkout code
        uses: actions/checkout@v2
      
      # Install/setup dependencies, currently just an installation of Django as
      # GitHub's VM comes preloaded with Python, powershell, and pip
      - name: Install Dependencies (Currently just installs Django)
        run: ./.github/scripts/setup-deps.ps1
        shell: pwsh

      # Runs custom Unit-Tests defined in ./mysite/pages/tests.py
      - name: Run Unit Tests (See ./mysite/pages/tests.py)
        run: ./.github/scripts/unit-test.ps1
        shell: pwsh