updated CI/CD #89
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Continuous integration testing for ChRIS Plugin. | ||
| # https://github.com/FNNDSC/python-chrisapp-template/wiki/Continuous-Integration | ||
| # | ||
| # - on push and PR: run pytest | ||
| # - on push to main: build and push container images as ":latest" | ||
| # - on push to semver tag: build and push container image with tag and | ||
| # upload plugin description to https://cube.chrisproject.org/api/v1/ | ||
| name: build | ||
| on: | ||
| push: | ||
| branches: [ main ] | ||
| tags: | ||
| - "v?[0-9]+.[0-9]+.[0-9]+*" | ||
| pull_request: | ||
| branches: [ main ] | ||
| jobs: | ||
| test: | ||
| name: Unit tests | ||
| if: False | ||
| runs-on: ubuntu-24.04 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: docker/setup-buildx-action@v3 | ||
| - name: Build | ||
| uses: docker/build-push-action@v5 | ||
| with: | ||
| build-args: extras_require=dev | ||
| context: . | ||
| load: true | ||
| push: false | ||
| tags: "localhost/local/app:dev" | ||
| cache-from: type=gha | ||
| cache-to: type=gha,mode=max | ||
| - name: Run pytest | ||
| run: | | ||
| docker run -v "$GITHUB_WORKSPACE:/app:ro" -w /app localhost/local/app:dev \ | ||
| pytest -o cache_dir=/tmp/pytest | ||
| build: | ||
| name: Build | ||
| if: github.event_name == 'push' || github.event_name == 'release' | ||
| # needs: [ test ] # uncomment to require passing tests | ||
| runs-on: ubuntu-24.04 | ||
| steps: | ||
| - name: Stop docker | ||
| run: sudo systemctl stop docker | ||
| - name: Clean docker data | ||
| run: | | ||
| sudo rm -rf /var/lib/docker | ||
| sudo mkdir /var/lib/docker | ||
| - name: Maximize build space | ||
| uses: easimon/maximize-build-space@6ae56c86ea8db291ae39f62352a412c36ab8179b | ||
| with: | ||
| root-reserve-mb: 8192 # space needed for logs | ||
| swap-size-mb: 1024 # must be >0 | ||
| build-mount-path: /var/lib/docker | ||
| remove-dotnet: 'true' | ||
| remove-android: 'true' | ||
| remove-haskell: 'true' | ||
| remove-codeql: 'true' | ||
| remove-docker-images: 'false' | ||
| - name: Start docker | ||
| run: sudo systemctl start docker | ||
| - name: Get git tag | ||
| id: git_info | ||
| if: startsWith(github.ref, 'refs/tags/') | ||
| run: echo "::set-output name=tag::${GITHUB_REF##*/}" | ||
| - name: Decide image tag name | ||
| id: determine | ||
| env: | ||
| git_tag: ${{ steps.git_info.outputs.tag }} | ||
| run: | | ||
| repo="${GITHUB_REPOSITORY,,}" # to lower case | ||
| # if build triggered by tag, use tag name | ||
| tag="${git_tag:-latest}" | ||
| dock_image=$repo:$tag | ||
| echo $dock_image | ||
| echo "::set-output name=dock_image::$dock_image" | ||
| echo "::set-output name=repo::$repo" | ||
| - uses: actions/checkout@v2 | ||
| # QEMU is for emulating non-x86_64 platforms | ||
| - uses: docker/setup-qemu-action@v1 | ||
| # buildx is the next-generation docker image builder | ||
| - uses: docker/setup-buildx-action@v1 | ||
| with: | ||
| driver-opts: network=host | ||
| # save some time during rebuilds | ||
| - name: Cache Docker layers | ||
| uses: actions/cache@v2 | ||
| with: | ||
| path: /tmp/.buildx-cache | ||
| key: ${{ runner.os }}-buildx-${{ github.sha }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-buildx- | ||
| - name: Login to DockerHub | ||
| id: dockerhub_login | ||
| uses: docker/login-action@v1 | ||
| with: | ||
| username: ${{ secrets.DOCKERHUB_USERNAME }} | ||
| password: ${{ secrets.DOCKERHUB_PASSWORD }} | ||
| - name: Login to GitHub Container Registry | ||
| uses: docker/login-action@v1 | ||
| with: | ||
| registry: ghcr.io | ||
| username: ${{ github.repository_owner }} | ||
| password: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: Build and push | ||
| uses: docker/build-push-action@v2 | ||
| id: docker_build | ||
| with: | ||
| context: . | ||
| file: ./Dockerfile | ||
| tags: | | ||
| ${{ steps.determine.outputs.dock_image }} | ||
| localhost:5000/${{ steps.determine.outputs.dock_image }} | ||
| ghcr.io/${{ steps.determine.outputs.dock_image }} | ||
| platforms: linux/amd64 | ||
| push: true | ||
| cache-from: type=local,src=/tmp/.buildx-cache | ||
| cache-to: type=local,dest=/tmp/.buildx-cache | ||
| - name: Get plugin meta | ||
| id: pluginmeta | ||
| run: | | ||
| repo=${{ steps.determine.outputs.repo }} | ||
| dock_image=${{ steps.determine.outputs.dock_image }} | ||
| docker pull localhost:5000/$dock_image | ||
| docker tag localhost:5000/$dock_image $dock_image | ||
| script=$(docker inspect --format '{{ (index .Config.Cmd 0) }}' $dock_image) | ||
| docker run --rm $dock_image $script --json \ | ||
| | jq '. += {"name":"pl-lld_inference", "dock_image": "'$dock_image'", "public_repo": "'${{ github.server_url }}/${{ github.repository }}'" }' \ | ||
| > /tmp/description.json | ||
| - name: Update DockerHub description | ||
| uses: peter-evans/dockerhub-description@v2 | ||
| continue-on-error: true # it is not crucial that this works | ||
| with: | ||
| username: ${{ secrets.DOCKERHUB_USERNAME }} | ||
| password: ${{ secrets.DOCKERHUB_PASSWORD }} | ||
| short-description: ${{ steps.pluginmeta.outputs.title }} | ||
| readme-filepath: ./README.rst | ||
| repository: ${{ steps.determine.outputs.repo }} | ||
| - name: Upload ChRIS Plugin | ||
| id: upload | ||
| if: github.ref_type == 'tag' | ||
| uses: FNNDSC/upload-chris-plugin@main | ||
| with: | ||
| description_file: /tmp/description.json | ||
| username: ${{ secrets.CHRISPROJECT_USERNAME }} | ||
| password: ${{ secrets.CHRISPROJECT_PASSWORD }} | ||
| chris_url: https://cube.chrisproject.org/api/v1/ | ||
| compute_names: NERC | ||
