main.yml

---
name: CI

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

on:
  workflow_dispatch:
  pull_request:
  push:
    branches: [main]

jobs:
  build-and-test:
    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: Test docker image
        run: just smoke-test

      - name: Save docker image
        run: |
          docker save research-template | pigz --fast > /tmp/research-template.tar.gz

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

  test-devcontainer:
    needs: [build-and-test]
    runs-on: ubuntu-latest

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

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

    - name: Tag Docker image for use with dev container
      run: docker tag $IMAGE_NAME $PUBLIC_IMAGE_NAME:v0

    - name: Checkout research template temporary devcontainer dev branch
      uses: actions/checkout@v4
      with:
        repository: opensafely/research-template
        # TODO: remove this branch
        ref: improve-devcontainers

    - name: Checkout research-template-docker repository in subdirectory
      uses: actions/checkout@v4
      with:
        path: 'research-template/research-template-docker'

    - name: List files
      run: ls ./research-template/research-template-docker

    - name: Build and run dev container task
      uses: devcontainers/ci@v0.3
      with:
        runCmd: ./research-template/research-template-docker/tests/dev_container.sh

  publish:
    needs: [build-and-test, test-devcontainer]

    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 load --input /tmp/image/research-template.tar.gz

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