main.yml

---
name: CI

env:
  IMAGE_NAME: research-template
  IMAGE_VERSION: v0
  PUBLIC_IMAGE_NAME: ghcr.io/opensafely-core/research-template
  REGISTRY: ghcr.io

on:
  workflow_dispatch:
  pull_request:
  push:
    branches: [main]
  schedule:
    - cron: "0 12 * * SUN"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: hadolint/hadolint-action@54c9adbab1582c2ef04b2016b760714a4bfde3cf  # v3.1.0
        # Lint the dockerfile before building
        with:
          failure-threshold: error
      - uses: "opensafely-core/setup-action@v1"
        with:
          install-just: true

      - name: Build docker image
        run: just build

      - name: Save docker image
        run: |
          docker image save research-template | zstd --fast -o /tmp/research-template.tar.zst

      - name: Upload docker image
        uses: actions/upload-artifact@v4
        with:
            name: research-template-image
            path: /tmp/research-template.tar.zst
            # Disable compression; the file is already compressed
            compression-level: 0

  test-docker-image:
    needs: build
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Install just
      uses: "opensafely-core/setup-action@v1"
      with:
        install-just: true

    - name: Download Docker image
      uses: actions/download-artifact@v4
      with:
        name: research-template-image
        path: /tmp/image

    - name: Import Docker image
      run: docker image load --input /tmp/image/research-template.tar.zst

    - name: Test Python installation
      run: just test-python-install

    - name: Test R Studio installation
      run: just test-rstudio-install

    - name: Test packages
      run: just test-packages

  publish:
    needs: [build, test-docker-image]

    runs-on: ubuntu-latest

    permissions:
      contents: read
      packages: write

    if: github.ref == 'refs/heads/main'

    steps:
      - uses: actions/checkout@v4
      - uses: "opensafely-core/setup-action@v1"
        with:
          install-just: true

      - name: Download docker image
        uses: actions/download-artifact@v4
        with:
            name: research-template-image
            path: /tmp/image

      - name: Import docker image
        run: docker image load --input /tmp/image/research-template.tar.zst

      - name: Publish image
        run: |
            echo ${{ secrets.GITHUB_TOKEN }} | docker login "$REGISTRY" -u ${{ github.actor }} --password-stdin
            docker tag "$IMAGE_NAME" "$PUBLIC_IMAGE_NAME:$IMAGE_VERSION"
            docker tag "$IMAGE_NAME" "$PUBLIC_IMAGE_NAME:latest"
            docker push "$PUBLIC_IMAGE_NAME:$IMAGE_VERSION"
            docker push "$PUBLIC_IMAGE_NAME:latest"