Documentation (#7679) #6639
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
| # Copyright (c) 2016-2024 Martin Donath <[email protected]> | |
| # Permission is hereby granted, free of charge, to any person obtaining a copy | |
| # of this software and associated documentation files (the "Software"), to | |
| # deal in the Software without restriction, including without limitation the | |
| # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or | |
| # sell copies of the Software, and to permit persons to whom the Software is | |
| # furnished to do so, subject to the following conditions: | |
| # The above copyright notice and this permission notice shall be included in | |
| # all copies or substantial portions of the Software. | |
| # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| # FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE | |
| # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | |
| # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | |
| # IN THE SOFTWARE. | |
| name: build | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| release: | |
| types: | |
| - published | |
| env: | |
| NODE_VERSION: 18.x | |
| PYTHON_VERSION: 3.x | |
| permissions: | |
| contents: read | |
| jobs: | |
| npm-build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Node.js runtime | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Set up Node.js dependency cache | |
| uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }} | |
| path: node_modules | |
| - name: Set up Node.js dependencies | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: npm install | |
| - name: Build project | |
| run: | | |
| npm run build | |
| git diff --name-only | |
| npm-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Node.js runtime | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Set up Node.js dependency cache | |
| uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }} | |
| path: node_modules | |
| - name: Set up Node.js dependencies | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: npm install | |
| - name: Check project | |
| run: npm run check | |
| python: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python runtime | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| cache: pip | |
| cache-dependency-path: | | |
| pyproject.toml | |
| requirements.txt | |
| - name: Set up Python dependencies | |
| run: pip install --upgrade build twine | |
| - name: Build Python package | |
| run: python -m build | |
| - name: Publish Python package | |
| if: github.event_name == 'release' | |
| env: | |
| PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }} | |
| PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }} | |
| run: twine upload --disable-progress-bar -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} dist/* | |
| docker: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - 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 == 'release' | |
| uses: docker/login-action@v3 | |
| with: | |
| username: ${{ secrets.DOCKER_USERNAME }} | |
| password: ${{ secrets.DOCKER_PASSWORD }} | |
| - name: Login to GitHub Container Registry | |
| if: github.event_name == 'release' | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.repository_owner }} | |
| password: ${{ secrets.GHCR_TOKEN }} | |
| - name: Generate Docker tags and labels | |
| id: meta | |
| uses: docker/metadata-action@v5 | |
| with: | |
| images: | | |
| ${{ github.event.repository.full_name }} | |
| ghcr.io/${{ github.event.repository.full_name }} | |
| tags: | | |
| type=semver,pattern={{version}} | |
| type=semver,pattern={{major}}.{{minor}} | |
| type=semver,pattern={{major}} | |
| type=ref,event=branch | |
| type=ref,event=pr | |
| flavor: | | |
| latest=${{ github.event.release.prerelease == false }} | |
| - name: Build Docker image | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: . | |
| load: true | |
| tags: ${{ steps.meta.outputs.tags }} | |
| labels: ${{ steps.meta.outputs.labels }} | |
| - name: Check Docker image | |
| working-directory: /tmp | |
| env: | |
| REPO_FULL_NAME: '${{ github.event.repository.full_name }}' | |
| run: | | |
| docker run --rm -i -v ${PWD}:/docs ${REPO_FULL_NAME,,}:${{ steps.meta.outputs.version }} new . | |
| docker run --rm -i -v ${PWD}:/docs ${REPO_FULL_NAME,,}:${{ steps.meta.outputs.version }} build | |
| - name: Set platforms | |
| if: github.event_name == 'release' | |
| run: | | |
| echo "PLATFORMS=linux/amd64,linux/arm64,linux/arm/v7" >> $GITHUB_ENV | |
| - name: Publish Docker image | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: . | |
| platforms: ${{ env.PLATFORMS }} | |
| push: ${{ github.event_name == 'release' }} | |
| tags: ${{ steps.meta.outputs.tags }} | |
| labels: ${{ steps.meta.outputs.labels }} | |
| - name: Check manifest | |
| if: github.event_name == 'release' | |
| run: | | |
| docker buildx imagetools inspect ${{ github.event.repository.full_name }}:${{ steps.meta.outputs.version }} | |
| - name: Inspect image | |
| if: github.event_name == 'release' | |
| run: | | |
| docker pull ${{ github.event.repository.full_name }}:${{ steps.meta.outputs.version }} | |
| docker image inspect ${{ github.event.repository.full_name }}:${{ steps.meta.outputs.version }} |