Skip to content

Improve documentation #2285

Improve documentation

Improve documentation #2285

Workflow file for this run

name: Onyxia API CI
on:
#schedule:
#- cron: "0 10 * * *" # everyday at 10am
push:
branches:
- "**"
paths-ignore:
- 'docs/**'
tags:
- "*"
pull_request:
paths-ignore:
- 'docs/**'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up JDK 21
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 21
- name: Set current version
run: mvn -B versions:set -DnewVersion=${GITHUB_REF##*/} -DprocessAllModules -DgenerateBackupPoms=false
- name: Build with Maven
run: mvn -B package
- name: Upload jar
uses: actions/upload-artifact@v4
with:
name: jar
path: onyxia-api/target/*.jar
spotless-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up JDK 21
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 21
- name: Check Spotless CodingStyle
run: mvn spotless:check
docker:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Download jar
id: download
uses: actions/download-artifact@v4
with:
name: jar
path: onyxia-api/target
- name: Docker meta
id: docker_meta
uses: crazy-max/ghaction-docker-meta@v5.5.1
with:
images: inseefrlab/onyxia-api # list of Docker images to use as base name for tags
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Login to DockerHub
if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push
uses: docker/build-push-action@v6
with:
context: onyxia-api
platforms: linux/amd64,linux/arm64
file: onyxia-api/Dockerfile
push: ${{ github.event_name != 'pull_request' }}
tags: |
${{ steps.docker_meta.outputs.tags }}
${{ github.ref == 'refs/heads/main' && 'inseefrlab/onyxia-api:latest' || '' }}
labels: ${{ steps.docker_meta.outputs.labels }}
- name: Image digest
run: echo ${{ steps.docker_build.outputs.digest }}