-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* [#13] reuse open-api-workflows workflows --------- Co-authored-by: Sonny Bakker <[email protected]>
- Loading branch information
Showing
24 changed files
with
320 additions
and
479 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,26 +29,12 @@ jobs: | |
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| - name: Set up backend environment | ||
| uses: maykinmedia/[email protected] | ||
| with: | ||
| apt-packages: 'libgdal-dev gdal-bin' | ||
| python-version: '3.11' | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '18' | ||
|
|
||
| - name: Install system packages | ||
| run: | | ||
| sudo apt-get update \ | ||
| && sudo apt-get install -y --no-install-recommends \ | ||
| libgdal-dev \ | ||
| gdal-bin | ||
| - name: Install dependencies | ||
| run: pip install -r requirements/ci.txt codecov | ||
| - name: Build frontend | ||
| run: | | ||
| npm ci | ||
| npm run build | ||
| setup-node: true | ||
|
|
||
| - name: Run tests | ||
| run: | | ||
|
|
@@ -61,27 +47,21 @@ jobs: | |
| DB_PASSWORD: '' | ||
|
|
||
| - name: Publish coverage report | ||
| uses: codecov/codecov-action@v3 | ||
| uses: codecov/codecov-action@v4 | ||
|
|
||
| docs: | ||
| runs-on: ubuntu-latest | ||
| name: Documentation build | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| - name: Set up backend environment | ||
| uses: maykinmedia/[email protected] | ||
| with: | ||
| apt-packages: 'libgdal-dev gdal-bin' | ||
| python-version: '3.11' | ||
| cache: 'pip' | ||
| cache-dependency-path: 'requirements/*.txt' | ||
| - name: Install system packages | ||
| run: | | ||
| sudo apt-get update \ | ||
| && sudo apt-get install -y --no-install-recommends \ | ||
| libgdal-dev \ | ||
| gdal-bin | ||
| - name: Install dependencies | ||
| run: pip install -r requirements/ci.txt pytest | ||
| setup-node: false | ||
|
|
||
| - name: Generate environment variable documentation using OAf and check if it was updated | ||
| run: | | ||
| bin/generate_envvar_docs.sh | ||
|
|
@@ -94,81 +74,35 @@ jobs: | |
| env: | ||
| DJANGO_SETTINGS_MODULE: objects.conf.ci | ||
|
|
||
| docker: | ||
| needs: tests | ||
|
|
||
| name: Build (and push) Docker image | ||
| store-reusable-workflow-vars: | ||
| name: create values which can be passed through a reusable workflow | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| image-name: ${{ steps.image-name.outputs.image-name }} | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Set tag | ||
| id: vars | ||
| run: | | ||
| # Strip git ref prefix from version | ||
| VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,') | ||
| # Strip "v" prefix from tag name (if present at all) | ||
| [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//') | ||
| # Use Docker `latest` tag convention | ||
| [ "$VERSION" == "master" ] && VERSION=latest | ||
| echo ::set-output name=tag::${VERSION} | ||
| - name: Build the Docker image | ||
| env: | ||
| RELEASE_VERSION: ${{ steps.vars.outputs.tag }} | ||
| run: docker build . --tag $IMAGE_NAME:$RELEASE_VERSION | ||
|
|
||
| - run: docker image save -o image.tar $IMAGE_NAME:${{ steps.vars.outputs.tag }} | ||
|
|
||
| - name: Store image artifact | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: docker-image | ||
| path: image.tar | ||
| retention-days: 1 | ||
| - run: echo "image-name=$IMAGE_NAME" >> $GITHUB_OUTPUT | ||
| name: 'Store the docker image name' | ||
| id: image-name | ||
|
|
||
| publish: | ||
| open-api-ci: | ||
| uses: maykinmedia/open-api-workflows/.github/workflows/ci.yml@v1 | ||
| needs: | ||
| - store-reusable-workflow-vars | ||
| with: | ||
| main-branch: 'master' | ||
| python-version: '3.11' | ||
| docker-image-name: ${{ needs.store-reusable-workflow-vars.outputs.image-name }} | ||
|
|
||
| open-api-publish: | ||
| uses: maykinmedia/open-api-workflows/.github/workflows/publish.yml@v1 | ||
| needs: | ||
| - store-reusable-workflow-vars | ||
| - open-api-ci | ||
| - tests | ||
| - docker | ||
|
|
||
| name: Push Docker image | ||
| runs-on: ubuntu-latest | ||
| if: github.event_name == 'push' # exclude PRs | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Download built image | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: docker-image | ||
|
|
||
| - name: Determine tag | ||
| id: vars | ||
| run: | | ||
| # Strip git ref prefix from version | ||
| VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,') | ||
| # Strip "v" prefix from tag name (if present at all) | ||
| [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//') | ||
| # Use Docker `latest` tag convention | ||
| [ "$VERSION" == "master" ] && VERSION=latest | ||
| echo ::set-output name=tag::${VERSION} | ||
| - name: Load image | ||
| run: | | ||
| docker image load -i image.tar | ||
| - name: Log into registry | ||
| run: echo "${{ secrets.DOCKER_TOKEN }}" | docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin | ||
|
|
||
| - name: Push the Docker image | ||
| env: | ||
| RELEASE_VERSION: ${{ steps.vars.outputs.tag }} | ||
| run: docker push $IMAGE_NAME:$RELEASE_VERSION | ||
| with: | ||
| docker-image-name: ${{ needs.store-reusable-workflow-vars.outputs.image-name }} | ||
| repository-owner: 'maykinmedia' | ||
| secrets: | ||
| docker-username: ${{ secrets.DOCKER_USERNAME }} | ||
| docker-token: ${{ secrets.DOCKER_TOKEN }} | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,25 @@ | ||
| name: code-quality | ||
|
|
||
| on: [push] | ||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| paths: | ||
| - '**.py' | ||
| - '**.yml' | ||
| pull_request: | ||
| paths: | ||
| - '**.py' | ||
| - '**.yml' | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| isort: | ||
| name: Check import sorting | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.11' | ||
| - uses: isort/isort-action@v1 | ||
| with: | ||
| requirementsFiles: requirements/dev.txt | ||
| sortPaths: "src docs" | ||
| configuration: '--check-only --diff' | ||
|
|
||
| black: | ||
| name: Check code formatting with black | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.11' | ||
| - name: Install dependencies | ||
| run: | | ||
| pip install -r requirements/dev.txt | ||
| - name: Run black | ||
| run: | | ||
| black --check src docs | ||
| oas-up-to-date: | ||
| name: Check for unexpected OAS changes | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.11' | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '18' | ||
|
|
||
| - name: Install system packages | ||
| run: | | ||
| sudo apt-get update \ | ||
| && sudo apt-get install -y --no-install-recommends \ | ||
| libgdal-dev \ | ||
| gdal-bin | ||
| - name: Install dependencies | ||
| run: pip install -r requirements/ci.txt | ||
|
|
||
| - name: Generate OAS files | ||
| run: ./bin/generate_schema.sh openapi.yaml | ||
| env: | ||
| DJANGO_SETTINGS_MODULE: objects.conf.ci | ||
|
|
||
| - name: Check for OAS changes | ||
| run: | | ||
| diff openapi.yaml src/objects/api/v2/openapi.yaml | ||
| - name: Write failure markdown | ||
| if: ${{ failure() }} | ||
| run: | | ||
| echo 'Run the following command locally and commit the changes' >> $GITHUB_STEP_SUMMARY | ||
| echo '' >> $GITHUB_STEP_SUMMARY | ||
| echo '```bash' >> $GITHUB_STEP_SUMMARY | ||
| echo './bin/generate_schema.sh' >> $GITHUB_STEP_SUMMARY | ||
| echo '```' >> $GITHUB_STEP_SUMMARY | ||
| open-api-workflow-code-quality: | ||
| uses: maykinmedia/open-api-workflows/.github/workflows/code-quality.yml@v1 | ||
| with: | ||
| apt-packages: 'libgdal-dev gdal-bin' | ||
| python-version: '3.11' | ||
| node-version: '18' | ||
| postgres-image: 'postgis/postgis:12-2.5' | ||
|
|
||
| django-settings-module: 'objects.conf.ci' |
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
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
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
Oops, something went wrong.