Prep 1.0.0 Update Docs and Dev Code to 2025 standards #659
This file contains hidden or 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: "CI" | |
| concurrency: # Cancel any existing runs of this workflow for this same PR | |
| group: "${{ github.workflow }}-${{ github.ref }}" | |
| cancel-in-progress: true | |
| on: # yamllint disable-line rule:truthy rule:comments | |
| push: | |
| branches: | |
| - "main" | |
| - "develop" | |
| tags: | |
| - "v*" | |
| pull_request: ~ | |
| env: | |
| INVOKE_JDIFF_IMAGE_NAME: "jdiff" | |
| INVOKE_JDIFF_IMAGE_VER: "latest" | |
| jobs: | |
| ruff-format: | |
| runs-on: "ubuntu-24.04" | |
| env: | |
| INVOKE_JDIFF_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v6" | |
| with: | |
| poetry-version: "1.8.5" | |
| - name: "Linting: ruff format" | |
| run: "poetry run invoke ruff --action format" | |
| ruff-lint: | |
| runs-on: "ubuntu-24.04" | |
| env: | |
| INVOKE_JDIFF_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v6" | |
| with: | |
| poetry-version: "1.8.5" | |
| - name: "Linting: ruff" | |
| run: "poetry run invoke ruff --action lint" | |
| mypy: | |
| runs-on: "ubuntu-24.04" | |
| env: | |
| INVOKE_JDIFF_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v6" | |
| with: | |
| python-version: "3.13" | |
| - name: "Type-Hints: mypy" | |
| run: "poetry run invoke mypy" | |
| needs: | |
| - "ruff-format" | |
| - "ruff-lint" | |
| # Temporarily disabled due to issues with the docs build and needing best practices for NTC python builds. | |
| # check-docs-build: | |
| # runs-on: "ubuntu-24.04" | |
| # env: | |
| # INVOKE_JDIFF_LOCAL: "True" | |
| # steps: | |
| # - name: "Check out repository code" | |
| # uses: "actions/checkout@v4" | |
| # - name: "Setup environment" | |
| # uses: "networktocode/gh-action-setup-poetry-environment@v6" | |
| # with: | |
| # poetry-version: "1.8.5" | |
| # - name: "Check Docs Build" | |
| # run: "poetry run invoke build-and-check-docs" | |
| poetry: | |
| runs-on: "ubuntu-24.04" | |
| env: | |
| INVOKE_JDIFF_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v6" | |
| with: | |
| poetry-version: "1.8.5" | |
| - name: "Checking: poetry lock file" | |
| run: "poetry lock --check" | |
| needs: | |
| - "ruff-format" | |
| - "ruff-lint" | |
| - "mypy" | |
| - "yamllint" | |
| yamllint: | |
| runs-on: "ubuntu-24.04" | |
| env: | |
| INVOKE_JDIFF_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v6" | |
| with: | |
| poetry-version: "1.8.5" | |
| - name: "Linting: yamllint" | |
| run: "poetry run invoke yamllint" | |
| needs: | |
| - "ruff-format" | |
| - "ruff-lint" | |
| pylint: | |
| runs-on: "ubuntu-24.04" | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] | |
| env: | |
| PYTHON_VER: "${{ matrix.python-version }}" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v6" | |
| - name: "Get image version" | |
| run: "echo INVOKE_JDIFF_IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV" | |
| - name: "Set up Docker Buildx" | |
| id: "buildx" | |
| uses: "docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2" # v3.10.0 | |
| - name: "Build" | |
| uses: "docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25" # v5.4.0 | |
| with: | |
| builder: "${{ steps.buildx.outputs.name }}" | |
| context: "./" | |
| push: false | |
| load: true | |
| tags: "${{ env.INVOKE_JDIFF_IMAGE_NAME }}:${{ env.INVOKE_JDIFF_IMAGE_VER }}" | |
| file: "./Dockerfile" | |
| cache-from: "type=gha,scope=${{ env.INVOKE_JDIFF_IMAGE_NAME }}-${{ env.INVOKE_JDIFF_IMAGE_VER }}-py${{ matrix.python-version }}" | |
| cache-to: "type=gha,scope=${{ env.INVOKE_JDIFF_IMAGE_NAME }}-${{ env.INVOKE_JDIFF_IMAGE_VER }}-py${{ matrix.python-version }}" | |
| build-args: | | |
| PYTHON_VER=${{ env.PYTHON_VER }} | |
| - name: "Debug: Show docker images" | |
| run: "docker image ls" | |
| - name: "Linting: Pylint" | |
| run: "poetry run invoke pylint" | |
| needs: | |
| - "poetry" | |
| pytest: | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] | |
| runs-on: "ubuntu-24.04" | |
| env: | |
| PYTHON_VER: "${{ matrix.python-version }}" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v6" | |
| - name: "Get image version" | |
| run: "echo INVOKE_JDIFF_IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV" | |
| - name: "Set up Docker Buildx" | |
| id: "buildx" | |
| uses: "docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2" # v3.10.0 | |
| - name: "Build" | |
| uses: "docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25" # v5.4.0 | |
| with: | |
| builder: "${{ steps.buildx.outputs.name }}" | |
| context: "./" | |
| push: false | |
| load: true | |
| tags: "${{ env.INVOKE_JDIFF_IMAGE_NAME }}:${{ env.INVOKE_JDIFF_IMAGE_VER }}" | |
| file: "./Dockerfile" | |
| cache-from: "type=gha,scope=${{ env.INVOKE_JDIFF_IMAGE_NAME }}-${{ env.INVOKE_JDIFF_IMAGE_VER }}-py${{ matrix.python-version }}" | |
| cache-to: "type=gha,scope=${{ env.INVOKE_JDIFF_IMAGE_NAME }}-${{ env.INVOKE_JDIFF_IMAGE_VER }}-py${{ matrix.python-version }}" | |
| build-args: | | |
| PYTHON_VER=${{ env.PYTHON_VER }} | |
| - name: "Debug: Show docker images" | |
| run: "docker image ls" | |
| - name: "Run Tests" | |
| run: "poetry run invoke pytest" | |
| needs: | |
| - "poetry" | |
| publish_gh: | |
| name: "Publish to GitHub" | |
| runs-on: "ubuntu-24.04" | |
| # yamllint disable-line rule:quoted-strings | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Set up Python" | |
| uses: "actions/setup-python@v5" | |
| with: | |
| python-version: "3.9" | |
| - name: "Install Python Packages" | |
| run: "pip install poetry" | |
| - name: "Set env" | |
| run: "echo RELEASE_VERSION=${GITHUB_REF:10} >> $GITHUB_ENV" | |
| - name: "Run Poetry Version" | |
| run: "poetry version $RELEASE_VERSION" | |
| - name: "Build Documentation" | |
| run: "poetry run invoke build-and-check-docs" | |
| - name: "Run Poetry Build" | |
| run: "poetry build" | |
| - name: "Upload binaries to release" | |
| run: "gh release upload ${{ github.ref_name }} dist/*.{tar.gz,whl}" | |
| env: | |
| GH_TOKEN: "${{ secrets.NTC_GITHUB_TOKEN }}" | |
| needs: | |
| - "pytest" | |
| publish_pypi: | |
| name: "Push Package to PyPI" | |
| runs-on: "ubuntu-24.04" | |
| # yamllint disable-line rule:quoted-strings | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v4" | |
| - name: "Set up Python" | |
| uses: "actions/setup-python@v5" | |
| with: | |
| python-version: "3.9" | |
| - name: "Install Python Packages" | |
| run: "pip install poetry" | |
| - name: "Set env" | |
| run: "echo RELEASE_VERSION=${GITHUB_REF:10} >> $GITHUB_ENV" | |
| - name: "Run Poetry Version" | |
| run: "poetry version $RELEASE_VERSION" | |
| - name: "Run Poetry Build" | |
| run: "poetry build" | |
| - name: "Push to PyPI" | |
| uses: "pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc" # v1.12.4 | |
| with: | |
| user: "__token__" | |
| password: "${{ secrets.PYPI_API_TOKEN }}" | |
| needs: | |
| - "pytest" | |
| slack-notify: | |
| needs: | |
| - "publish_gh" | |
| - "publish_pypi" | |
| runs-on: "ubuntu-24.04" | |
| env: | |
| SLACK_WEBHOOK_URL: "${{ secrets.SLACK_WEBHOOK_URL }}" | |
| SLACK_MESSAGE: >- | |
| *NOTIFICATION: NEW-RELEASE-PUBLISHED*\n | |
| Repository: <${{ github.server_url }}/${{ github.repository }}|${{ github.repository }}>\n | |
| Release: <${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.ref_name }}|${{ github.ref_name }}>\n | |
| Published by: <${{ github.server_url }}/${{ github.actor }}|${{ github.actor }}> | |
| steps: | |
| - name: "Send a notification to Slack" | |
| # ENVs cannot be used directly in job.if. This is a workaround to check | |
| # if SLACK_WEBHOOK_URL is present. | |
| if: "env.SLACK_WEBHOOK_URL != ''" | |
| uses: "slackapi/slack-github-action@fcfb566f8b0aab22203f066d80ca1d7e4b5d05b3" # v1.27.1 | |
| with: | |
| payload: | | |
| { | |
| "text": "${{ env.SLACK_MESSAGE }}", | |
| "blocks": [ | |
| { | |
| "type": "section", | |
| "text": { | |
| "type": "mrkdwn", | |
| "text": "${{ env.SLACK_MESSAGE }}" | |
| } | |
| } | |
| ] | |
| } | |
| env: | |
| SLACK_WEBHOOK_URL: "${{ secrets.SLACK_WEBHOOK_URL }}" | |
| SLACK_WEBHOOK_TYPE: "INCOMING_WEBHOOK" |