Skip to content

Archiver: Add user to runtime docker image #289

Archiver: Add user to runtime docker image

Archiver: Add user to runtime docker image #289

name: Docker Image CI
env:
# Use docker.io for Docker Hub if empty
REGISTRY: ghcr.io
# github.repository as <account>/<repo>
OPENEM_FLOWS_IMAGE_NAME: ${{ github.repository }}-archiver-service-workflow
OPENEM_BACKEND_IMAGE_NAME: ${{ github.repository }}-archiver-service-api
OPENEM_CONFIG_IMAGE_NAME: ${{ github.repository }}-archiver-service-config
on:
push:
branches:
- main
pull_request:
workflow_dispatch:
jobs:
detect_changes:
runs-on: ubuntu-latest
# Required permissions
permissions:
pull-requests: read
# Set job outputs to values from filter step
outputs:
backend: ${{ steps.filter.outputs.backend }}
steps:
# For pull requests it's not necessary to checkout the code
- uses: actions/checkout@v4
if: github.event_name != 'pull_request'
- uses: dorny/paths-filter@v3
id: filter
with:
filters: |
backend:
- 'backend/**'
api:
- 'backend/api/**'
archiver:
- 'backend/archiver/**'
prefect:
- 'backend/prefect/prefect/**'
# test_api_server:
# runs-on: ubuntu-latest
# needs: detect_changes
# steps:
# - uses: actions/checkout@v4
# - name: Set up Python
# uses: actions/setup-python@v5
# with:
# python-version: '3.11'
# - name: Install dependencies and run tests
# working-directory: ./backend/api/src/openapi_server
# run: |
# python -m pip install --upgrade pip
# python -m pip install pipenv
# pipenv sync
# pipenv run pytest --junitxml=junit/test-results.xml --cov=. --cov-report=xml --cov-report=html
# - name: Upload pytest test results
# uses: actions/upload-artifact@v4
# with:
# name: api-test-results
# path: ./backend/junit/test-results.xml
# # Use always() to always run this step to publish test results when there are test failures
# if: ${{ always() }}
#
test_flows:
runs-on: ubuntu-latest
needs: detect_changes
if: ${{ needs.detect_changes.outputs.archiver == 'true' }} || github.event_name != 'pull_request'
defaults:
run:
working-directory: ./backend/archiver
steps:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.6.1"
- name: "Set up Python"
uses: actions/setup-python@v5
with:
python-version-file: backend/archiver/pyproject.toml
- name: Install the project
run: |
uv sync --all-extras --dev
uv add pytest-md-report
- name: Run tests
env:
REPORT_OUTPUT: md_report.md
shell: bash
run: |
echo "REPORT_FILE=${REPORT_OUTPUT}" >> "$GITHUB_ENV"
uv run pytest --md-report --md-report-flavor gfm --md-report-exclude-outcomes passed skipped xpassed --md-report-output "$REPORT_OUTPUT" --cov=. --cov-report=xml --cov-report=html
- name: Render the report to the PR when tests fail
uses: marocchino/sticky-pull-request-comment@v2
if: failure()
with:
header: test-report
recreate: true
path: ${{ env.REPORT_FILE }}
- name: Output reports to the job summary when tests fail
shell: bash
run: |
if [ -f "$REPORT_FILE" ]; then
echo "<details><summary>Failed Test Report</summary>" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
cat "$REPORT_FILE" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "</details>" >> $GITHUB_STEP_SUMMARY
fi
build_flows_image:
runs-on: ubuntu-latest
permissions:
packages: write
contents: read
needs: test_flows
if: ${{ needs.detect_changes.outputs.archiver == 'true' }} || github.event_name != 'pull_request'
steps:
- uses: actions/checkout@v4
- name: Log into registry ${{ env.REGISTRY }}
# if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.OPENEM_FLOWS_IMAGE_NAME }}
- name: Build and push Docker image
id: build-and-push
uses: docker/build-push-action@v6
with:
context: ./backend/archiver
file: ./backend/prefect/runtime.Dockerfile
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
build_config_image:
runs-on: ubuntu-latest
permissions:
packages: write
contents: read
needs: test_flows
if: ${{ needs.detect_changes.outputs.prefect == 'true' }} || github.event_name != 'pull_request'
steps:
- uses: actions/checkout@v4
- name: Log into registry ${{ env.REGISTRY }}
# if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
with:
images: ${{ env.REGISTRY }}/${{ env.OPENEM_CONFIG_IMAGE_NAME }}
- name: Build and push Docker image
id: build-and-push
uses: docker/build-push-action@v6
with:
context: ./backend/
file: ./backend/prefect/config.Dockerfile
push: ${{ github.event_name != 'pull_request' }}
build-args: PREFECT_VERSION=3.1.11-python3.11
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
build_service_api_image:
runs-on: ubuntu-latest
permissions:
packages: write
contents: read
needs: detect_changes
if: ${{ needs.detect_changes.outputs.backend == 'true' }} || github.event_name != 'pull_request'
steps:
- uses: actions/checkout@v4
- name: Ruff Format
uses: astral-sh/ruff-action@v3
with:
version: 0.8.0
args: "format --check"
src: ./backend/api
- name: Ruff Check
uses: astral-sh/ruff-action@v3
with:
version: 0.8.0
args: "check"
src: ./backend/api
- name: Log into registry ${{ env.REGISTRY }}
# if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@v5 # v5.0.0
with:
images: ${{ env.REGISTRY }}/${{ env.OPENEM_BACKEND_IMAGE_NAME }}
- name: Build and push
uses: docker/bake-action@v6
id: build-and-push
with:
workdir: ./
targets: archiver-service-api
push: ${{ github.event_name != 'pull_request' }}
set: |
*.tags=${{ steps.meta.outputs.tags }}
env:
OPENEM_IMAGE_TAG: ${{ steps.meta.outputs.tags }}