The-OpenROAD-Project_OpenROAD-flow-scripts/.github/workflows/github-actions-publish-docker-images.yml

name: Build and publish ORFS images
on:
  push:
    paths:
      - etc/DependencyInstaller.sh
      - etc/DockerHelper.sh
      - .github/workflows/github-actions-publish-docker-images.yml
      - build_openroad.sh
      - env.sh
      - flow/Makefile
      - docker/Dockerfile.dev
      - docker/Dockerfile.builder
      - tools/codespace/scripts/**
      - tools/codespace/Dockerfile-lxqt
  pull_request:
    paths:
      - etc/DependencyInstaller.sh
      - etc/DockerHelper.sh
      - .github/workflows/github-actions-publish-docker-images.yml
      - build_openroad.sh
      - env.sh
      - flow/Makefile
      - docker/Dockerfile.dev
      - docker/Dockerfile.builder
      - tools/codespace/scripts/**
      - tools/codespace/Dockerfile-lxqt

permissions:
  contents: read
  packages: write

jobs:
  buildCodespaceImage:
    runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
    timeout-minutes: 600
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1

      - name: Set environment variables
        run: echo "IMAGE=ghcr.io/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@37fe631027851001ddb9b187196cc803df7f5f0e  # v4.3.0

      - name: Login to GitHub Container Registry (GHCR)
        if: github.event_name != 'pull_request'
        uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f  # v4.6.0
        with:
          registry: ghcr.io
          username: gha
          password: ${{ github.token }}

      - name: Build and export codespaces image
        uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a  # v7.3.0
        with:
          context: .
          push: true
          tags: ${{ env.IMAGE }}:lxqt
          file: tools/codespace/Dockerfile-lxqt
          cache-from: type=registry,ref=${{ env.IMAGE }}:lxqtbuildcache
          cache-to: type=registry,ref=${{ env.IMAGE }}:lxqtbuildcache

  buildDependenciesImage:
    strategy:
      fail-fast: false
      matrix:
        os: [["ubuntu20.04", "ubuntu:20.04"], ["ubuntu22.04", "ubuntu:22.04"]]
    runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
    steps:
      - name: Check out repository code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          fetch-depth: 1
          submodules: recursive

      - name: Set environment variables
        run: |
          echo "IMAGE_DEPS=ghcr.io/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')-dev/${{ matrix.os[0] }}" >> $GITHUB_ENV

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@37fe631027851001ddb9b187196cc803df7f5f0e  # v4.3.0

      - name: Login to GitHub Container Registry (GHCR)
        if: github.event_name != 'pull_request'
        uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f  # v4.6.0
        with:
          registry: ghcr.io
          username: gha
          password: ${{ github.token }}

      - name: Copy OpenROAD installer
        run: cp tools/OpenROAD/etc/DependencyInstaller.sh etc/InstallerOpenROAD.sh

      - name: Build and export dependencies image
        uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a  # v7.3.0
        with:
          context: etc
          push: true
          tags: ${{ env.IMAGE_DEPS }}:latest
          file: docker/Dockerfile.dev
          build-args: |
            fromImage=${{ matrix.os[1] }}
          cache-from: type=registry,ref=${{ env.IMAGE_DEPS }}:buildcache
          cache-to: type=registry,ref=${{ env.IMAGE_DEPS }}:buildcache,mode=max

  buildORFSImage:
    needs: buildDependenciesImage
    strategy:
      fail-fast: false
      matrix:
        os: ["ubuntu20.04", "ubuntu22.04"]
    runs-on: ubuntu-latest
    steps:
      - name: Free Disk Space
        uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be  # v1.3.1
        with:
          tool-cache: false

      - name: Check out repository code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          fetch-depth: 1
          submodules: recursive

      - name: Set environment variables
        run: |
          echo "IMAGE=ghcr.io/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')/${{ matrix.os }}" >> $GITHUB_ENV
          echo "IMAGE_DEPS=ghcr.io/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')-dev/${{ matrix.os }}" >> $GITHUB_ENV
          echo "NUM_THREADS=$(nproc)" >> $GITHUB_ENV

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@37fe631027851001ddb9b187196cc803df7f5f0e  # v4.3.0

      - name: Login to GitHub Container Registry (GHCR)
        if: github.event_name != 'pull_request'
        uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f  # v4.6.0
        with:
          registry: ghcr.io
          username: gha
          password: ${{ github.token }}

      - name: Build and export ORFS image
        uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a  # v7.3.0
        with:
          context: .
          push: true
          tags: ${{ env.IMAGE }}:latest
          file: docker/Dockerfile.builder
          build-args: |
            fromImage=${{ env.IMAGE_DEPS }}
            numThreads=${{ env.NUM_THREADS }}
          cache-from: type=registry,ref=${{ env.IMAGE }}:buildcache
          cache-to: type=registry,ref=${{ env.IMAGE }}:buildcache,mode=max