Skip to content

---

--- #1445

name: Test and deploy
on:
workflow_dispatch:
push:
release:
types: [published]
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
jobs:
test-django-system-check:
name: Tests - Django system check
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Create Docker network
run: docker network create uccser-development-stack
# Required for the node service
- name: Set DOCKER_UID variable
run: echo "DOCKER_UID=$(echo $UID)" >> $GITHUB_ENV
- name: Start systems
run: docker compose -f docker-compose.local.yml up -d
- name: Run Django system check
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py check --fail-level WARNING
test-content:
name: Tests - Content
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Create Docker network
run: docker network create uccser-development-stack
# Required for the node service
- name: Set DOCKER_UID variable
run: echo "DOCKER_UID=$(echo $UID)" >> $GITHUB_ENV
- name: Start systems
run: docker compose -f docker-compose.local.yml up -d
- name: Create static files
run: docker compose -f docker-compose.local.yml run --rm --user="root" node npm run generate-assets
- name: Collect static files
run: docker compose -f docker-compose.local.yml run --rm --user="root" django python ./manage.py collectstatic --no-input
- name: Migrate database
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py migrate
- name: Load content
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py updatedata
- name: Make resource thumbnails
run: docker compose -f docker-compose.local.yml run --rm --user="root" django python ./manage.py makeresourcethumbnails
- name: Collect static files
run: docker compose -f docker-compose.local.yml run --rm --user="root" django python ./manage.py collectstatic --no-input
test-general:
name: Tests - General
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run general tests
run: ./dev ci test_general
- name: Create coverage file
run: docker compose -f docker-compose.local.yml run --rm --user="root" django coverage xml -i
- name: Upload coverage file
uses: codecov/codecov-action@v4
with:
files: ./csunplugged/coverage.xml
verbose: true
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
test-resources:
name: Tests - Resources
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run resource tests
run: ./dev ci test_resources
- name: Create coverage file
run: docker compose -f docker-compose.local.yml run --rm --user="root" django coverage xml -i
- name: Upload coverage file
uses: codecov/codecov-action@v4
with:
files: ./csunplugged/coverage.xml
verbose: true
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
test-management:
name: Tests - Management
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run management tests
run: ./dev ci test_management
- name: Create coverage file
run: docker compose -f docker-compose.local.yml run --rm --user="root" django coverage xml -i
- name: Upload coverage file
uses: codecov/codecov-action@v4
with:
files: ./csunplugged/coverage.xml
verbose: true
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
test-style:
name: Tests - Style
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run style tests
run: ./dev ci style
test-docs:
name: Tests - Documentation
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5.1.0
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Build documentation
run: sphinx-build -b html -W docs/ docs/_build/
create-static-files:
name: Create static files
if: |
(github.ref == 'refs/heads/develop')
|| startsWith(github.ref, 'refs/heads/research-study-')
|| github.event_name == 'release'
runs-on: ubuntu-20.04
needs: [
test-django-system-check,
test-content,
test-general,
test-resources,
test-management,
test-style,
test-docs
]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Create Docker network
run: docker network create uccser-development-stack
# Required for the node service
- name: Set DOCKER_UID variable
run: echo "DOCKER_UID=$(echo $UID)" >> $GITHUB_ENV
- name: Start system
run: docker compose -f docker-compose.local.yml up -d
- name: Create production static files
run: docker compose -f docker-compose.local.yml run --rm --user="root" node npm run build
- name: Collect staticfiles
run: docker compose -f docker-compose.local.yml run --rm --user="root" django python manage.py collectstatic --no-input
- name: Archive static files
run: tar czf static-files.tar.gz --directory csunplugged/staticfiles/ .
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: static-files
path: static-files.tar.gz
retention-days: 3
create-resource-thumbnails:
name: Create resource thumbnails
if: |
(github.ref == 'refs/heads/develop')
|| startsWith(github.ref, 'refs/heads/research-study-')
|| github.event_name == 'release'
runs-on: ubuntu-20.04
needs: [
test-django-system-check,
test-content,
test-general,
test-resources,
test-management,
test-style,
test-docs
]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Create Docker network
run: docker network create uccser-development-stack
# Required for the node service
- name: Set DOCKER_UID variable
run: echo "DOCKER_UID=$(echo $UID)" >> $GITHUB_ENV
- name: Start system
run: docker compose -f docker-compose.local.yml up -d
- name: Create production static files
run: docker compose -f docker-compose.local.yml run --rm --user="root" node npm run build
- name: Migrate database
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py migrate
- name: Load resources
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py loadresources
- name: Make resource thumbnails
run: docker compose -f docker-compose.local.yml run --rm --user="root" django python ./manage.py makeresourcethumbnails --all-languages
- name: Archive static files
run: tar czf resource-thumbnails.tar.gz --directory csunplugged/build/img/resources/ .
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: resource-thumbnails
path: resource-thumbnails.tar.gz
retention-days: 3
create-at-a-distance-files:
name: Create at a distance files
if: |
(github.ref == 'refs/heads/develop')
|| startsWith(github.ref, 'refs/heads/research-study-')
|| github.event_name == 'release'
runs-on: ubuntu-20.04
strategy:
matrix:
language: [
'en',
]
fail-fast: true
needs: [
test-django-system-check,
test-content,
test-general,
test-resources,
test-management,
test-style,
test-docs
]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Create Docker network
run: docker network create uccser-development-stack
# Required for the node service
- name: Set DOCKER_UID variable
run: echo "DOCKER_UID=$(echo $UID)" >> $GITHUB_ENV
- name: Start system
run: docker compose -f docker-compose.local.yml up -d
- name: Create standard static files
run: docker compose -f docker-compose.local.yml run --rm --user="root" node npm run generate-assets
- name: Collect staticfiles
run: docker compose -f docker-compose.local.yml run --rm --user="root" django python manage.py collectstatic --no-input
- name: Migrate database
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py migrate
- name: Load at a distance data
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py load_at_a_distance_data
- name: Run decktape script
run: docker compose -f docker-compose.local.yml run --rm --user="root" decktape --language ${{ matrix.language }}
- name: Create speaker notes PDFs
run: docker compose -f docker-compose.local.yml run --rm --user="root" django python ./manage.py create_lesson_speaker_notes_pdfs --language ${{ matrix.language }}
- name: Archive static files
run: tar czf at-a-distance-files.tar.gz --directory csunplugged/build/slides/ .
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: at-a-distance-files-${{ matrix.language }}
path: at-a-distance-files.tar.gz
retention-days: 3
create-resources:
name: Create resources
if: |
(github.ref == 'refs/heads/develop')
|| startsWith(github.ref, 'refs/heads/research-study-')
|| github.event_name == 'release'
runs-on: ubuntu-20.04
strategy:
matrix:
language: [
'en',
'de',
'es',
'fr',
'mi',
'zh-hans',
]
fail-fast: true
needs: [
test-django-system-check,
test-content,
test-general,
test-resources,
test-management,
test-style,
test-docs
]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Create Docker network
run: docker network create uccser-development-stack
# Required for the node service
- name: Set DOCKER_UID variable
run: echo "DOCKER_UID=$(echo $UID)" >> $GITHUB_ENV
- name: Start system
run: docker compose -f docker-compose.local.yml up -d
- name: Create production static files
run: docker compose -f docker-compose.local.yml run --rm --user="root" node npm run build
- name: Migrate database
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py migrate
- name: Load resources
run: docker compose -f docker-compose.local.yml run --rm django python ./manage.py loadresources
- name: Make resources
run: docker compose -f docker-compose.local.yml run --rm --user="root" django python ./manage.py makeresources --language ${{ matrix.language }}
- name: Archive static files
run: tar czf resources.tar.gz --directory csunplugged/build/resources/ .
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: resources-${{ matrix.language }}
path: resources.tar.gz
retention-days: 3
publish-docker-image:
name: Create and publish Docker image
if: |
(github.ref == 'refs/heads/develop')
|| startsWith(github.ref, 'refs/heads/research-study-')
|| github.event_name == 'release'
runs-on: ubuntu-20.04
needs: [
create-static-files,
create-resource-thumbnails,
create-resources,
create-at-a-distance-files,
]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Download all workflow run artifacts
uses: actions/download-artifact@v4
with:
path: artifacts/
- name: Show file tree of artifacts directory
run: ls -R -l artifacts/
- name: Unpack all artifacts
run: |
mkdir -p csunplugged/staticfiles
tar -xz --file artifacts/static-files/static-files.tar.gz --directory csunplugged/staticfiles
mkdir -p csunplugged/staticfiles/img/resources
tar -xz --file artifacts/resource-thumbnails/resource-thumbnails.tar.gz --directory csunplugged/staticfiles/img/resources
mkdir -p csunplugged/staticfiles/resources
ls artifacts/resources-*/resources.tar.gz | xargs -n1 tar -xz --directory csunplugged/staticfiles/resources --file
mkdir -p csunplugged/staticfiles/slides
ls artifacts/at-a-distance-files-*/at-a-distance-files.tar.gz | xargs -n1 tar -xz --directory csunplugged/staticfiles/slides --file
- name: Log in to the Container registry
uses: docker/login-action@v3.1.0
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Setup Docker metadata
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=ref,event=tag,priority=1
type=ref,event=branch,priority=2
- name: Build and push Docker image
uses: docker/build-push-action@v5.3.0
with:
file: ./infrastructure/production/django/Dockerfile
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
build-args: |
GIT_SHA=${{ github.sha }}