docs: documentation overhaul #1179
Workflow file for this run
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
| name: Build and publish the nightly Docker image | |
| on: | |
| pull_request: | |
| branches: [ master ] | |
| types: [ opened, synchronize, ready_for_review ] | |
| push: | |
| branches: [ master ] | |
| workflow_dispatch: | |
| env: | |
| TEST_IMAGE_NAME: 'local/openrouteservice:test' | |
| PRODUCTION_IMAGE_NAME: 'openrouteservice/openrouteservice:nightly' | |
| BUILD_PLATFORMS: 'linux/amd64,linux/arm64/v8' | |
| jobs: | |
| # This way the env variables are accessible in the individual jobs | |
| prepare_environment: | |
| name: Prepare the environment variables | |
| runs-on: ubuntu-latest | |
| outputs: | |
| test_image_name: ${{ env.TEST_IMAGE_NAME }} | |
| production_image_name: ${{ env.PRODUCTION_IMAGE_NAME }} | |
| build_platforms: ${{ env.BUILD_PLATFORMS }} | |
| steps: | |
| - run: | | |
| echo "Publish environment variables" | |
| build_docker_images: | |
| name: Build the docker images | |
| runs-on: ubuntu-latest | |
| needs: | |
| - prepare_environment | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v2 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v2 | |
| id: buildx | |
| with: | |
| install: true | |
| - name: Build image for platforms ${{ needs.prepare_environment.outputs.build_platforms }} | |
| uses: docker/build-push-action@v4 | |
| with: | |
| context: . | |
| push: false | |
| load: false | |
| tags: ${{ needs.prepare_environment.outputs.test_image_name }}, ${{ needs.prepare_environment.outputs.production_image_name }} | |
| platforms: "${{ needs.prepare_environment.outputs.build_platforms }}" | |
| cache-from: type=gha | |
| cache-to: type=gha,mode=max | |
| run_docker_image_tests: | |
| name: Run & test ${{ matrix.platform }} | |
| runs-on: ${{ matrix.image }} | |
| needs: | |
| - prepare_environment | |
| - build_docker_images | |
| strategy: | |
| matrix: | |
| platform: [ linux/amd64,linux/arm64/v8 ] | |
| image: [ ubuntu-latest ] | |
| # linux/arm64/v8 is emulated with qemu and takes ages to build the graph. | |
| # Only run linux/arm64/v8 tests on ready PR and master. | |
| isDraftPR: | |
| - ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == true }} | |
| exclude: | |
| - isDraftPR: true | |
| platform: linux/arm64/v8 | |
| steps: | |
| - run: | | |
| echo "Run docker test for platform ${{ matrix.platform }}" | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set the wait time for arm64 | |
| run: | | |
| if [[ "${{ matrix.platform }}" == 'linux/arm64/v8' ]]; then | |
| # arm64 is emulated and takes longer to build the graph | |
| echo "Set HEALTH_WAIT_TIME to 600 for arm64" | |
| echo "HEALTH_WAIT_TIME=600" >> $GITHUB_ENV | |
| else | |
| echo "Set HEALTH_WAIT_TIME to 260 for non-arm64" | |
| echo "HEALTH_WAIT_TIME=260" >> $GITHUB_ENV | |
| fi | |
| - name: Set up QEMU for ${{ matrix.platform }} | |
| uses: docker/setup-qemu-action@v2 | |
| with: | |
| platforms: ${{ matrix.platform }} | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v2 | |
| id: buildx | |
| with: | |
| install: true | |
| - name: Install jq | |
| uses: awalsh128/cache-apt-pkgs-action@latest | |
| with: | |
| packages: jq moreutils | |
| version: 1.0 | |
| - name: Build image | |
| uses: docker/build-push-action@v4 | |
| with: | |
| context: . | |
| push: false | |
| load: true | |
| tags: ${{ needs.prepare_environment.outputs.test_image_name }} | |
| platforms: "${{ matrix.platform }}" | |
| cache-from: type=gha | |
| - name: Start container from previously build image and wait for successful checks | |
| run: | | |
| mkdir $(pwd)/graphs $(pwd)/conf | |
| sudo chown 1000:1000 $(pwd)/graphs $(pwd)/conf | |
| docker run -it -d -p 8080:8080 -v $(pwd)/graphs:/home/ors/ors-core/data/graphs -v $(pwd)/conf:/home/ors/ors-conf --name ors-instance ${{ needs.prepare_environment.outputs.test_image_name }} | |
| docker logs ors-instance | |
| # Check for health to turn 200 after the graphs are build and spring-boot completely started | |
| ./.github/utils/url_check.sh 127.0.0.1 8080 /ors/v2/health 200 ${{ env.HEALTH_WAIT_TIME }} | |
| # Check for correct preflight settings to avoid CORS issues with ORIGIN wildcard from the example config | |
| ./.github/utils/cors_check.sh 127.0.0.1 8080 /ors/v2/isochrones/geojson "https://example.org" 200 10 | |
| ./.github/utils/cors_check.sh 127.0.0.1 8080 /ors/v2/isochrones/geojson "https://example.com" 200 10 | |
| # Restart the container to apply the config changes | |
| docker stop ors-instance | |
| docker container prune -f | |
| docker run -it -d -p 8080:8080 -v $(pwd)/graphs:/home/ors/ors-core/data/graphs -v $(pwd)/conf:/home/ors/ors-conf -e ORS_CORS_ALLOWED_ORIGINS=https://example.org --name ors-instance ${{ needs.prepare_environment.outputs.test_image_name }} | |
| # Request preflight with https://example.com and https://example.org to see if it gets applied correctly | |
| ./.github/utils/cors_check.sh 127.0.0.1 8080 /ors/v2/isochrones/geojson "https://example.org" 200 50 | |
| # It should fail with http code 403 for https://example.com since the Origin is not covered. | |
| ./.github/utils/cors_check.sh 127.0.0.1 8080 /ors/v2/isochrones/geojson "https://example.com" 403 10 | |
| publish_docker: | |
| name: Publish the docker image to docker hub | |
| runs-on: ubuntu-latest | |
| needs: | |
| - prepare_environment | |
| - build_docker_images | |
| - run_docker_image_tests | |
| steps: | |
| - run: | | |
| echo "Publish image ${{ needs.prepare_environment.outputs.production_image_name }}" | |
| - name: Checkout | |
| uses: actions/[email protected] | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v1 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v2 | |
| id: buildx | |
| with: | |
| install: true | |
| - name: Login to DockerHub | |
| if: ${{ success() && github.ref == 'refs/heads/master' }} | |
| uses: docker/login-action@v2 | |
| with: | |
| username: ${{ secrets.DOCKER_USERNAME }} | |
| password: ${{ secrets.DOCKER_TOKEN }} | |
| - name: Publish nightly | |
| if: ${{ github.ref == 'refs/heads/master' }} | |
| uses: docker/build-push-action@v4 | |
| with: | |
| context: . | |
| push: true | |
| tags: ${{ needs.prepare_environment.outputs.production_image_name }} | |
| platforms: "${{ needs.prepare_environment.outputs.build_platforms }}" | |
| cache-from: type=gha |