hack the API #451
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: "CI" | |
| on: # yamllint disable-line rule:truthy rule:comments | |
| - "push" | |
| - "pull_request" | |
| concurrency: # Cancel any existing runs of this workflow for this same PR | |
| group: "${{ github.workflow }}-${{ github.ref }}" | |
| cancel-in-progress: true | |
| env: | |
| PLUGIN_NAME: "nautobot-firewall-models" | |
| jobs: | |
| black: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Linting: black" | |
| run: "poetry run invoke black" | |
| bandit: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Linting: bandit" | |
| run: "poetry run invoke bandit" | |
| pydocstyle: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Linting: pydocstyle" | |
| run: "poetry run invoke pydocstyle" | |
| flake8: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Linting: flake8" | |
| run: "poetry run invoke flake8" | |
| yamllint: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Linting: yamllint" | |
| run: "poetry run invoke yamllint" | |
| pylint: | |
| needs: | |
| - "bandit" | |
| - "pydocstyle" | |
| - "flake8" | |
| - "yamllint" | |
| - "black" | |
| runs-on: "ubuntu-20.04" | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.11"] | |
| nautobot-version: ["2.0.0-rc.2"] | |
| env: | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_PYTHON_VER: "${{ matrix.python-version }}" | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_NAUTOBOT_VER: "${{ matrix.nautobot-version }}" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Set up Docker Buildx" | |
| id: "buildx" | |
| uses: "docker/setup-buildx-action@v1" | |
| - name: "Build" | |
| uses: "docker/build-push-action@v2" | |
| with: | |
| builder: "${{ steps.buildx.outputs.name }}" | |
| context: "./" | |
| push: false | |
| load: true | |
| tags: "${{ env.PLUGIN_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}" | |
| file: "./development/Dockerfile" | |
| cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}" | |
| cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}" | |
| build-args: | | |
| NAUTOBOT_VER=${{ matrix.nautobot-version }} | |
| PYTHON_VER=${{ matrix.python-version }} | |
| - name: "Copy credentials" | |
| run: "cp development/creds.example.env development/creds.env" | |
| - name: "Linting: pylint" | |
| run: "poetry run invoke pylint" | |
| unittest: | |
| needs: | |
| - "pylint" | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.8"] | |
| db-backend: ["postgresql"] | |
| nautobot-version: ["2.0.0-rc.2"] | |
| # The include is a method to limit the amount of jobs ran. This essentially | |
| # means that in addition to standard postgres and stable, also the lowest | |
| # supported version and with mysql | |
| include: | |
| - python-version: "3.11" | |
| db-backend: "postgresql" | |
| nautobot-version: "2.0.0-rc.2" | |
| # TODO: Include the following, once mysql is working on CI | |
| # - python-version: "3.7" | |
| # db-backend: "mysql" | |
| # nautobot-version: "1.4.1" | |
| # - python-version: "3.10" | |
| # db-backend: "mysql" | |
| # nautobot-version: "latest" | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_PYTHON_VER: "${{ matrix.python-version }}" | |
| INVOKE_NAUTOBOT_FIREWALL_MODELS_NAUTOBOT_VER: "${{ matrix.nautobot-version }}" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Set up Docker Buildx" | |
| id: "buildx" | |
| uses: "docker/setup-buildx-action@v1" | |
| - name: "Build" | |
| uses: "docker/build-push-action@v2" | |
| with: | |
| builder: "${{ steps.buildx.outputs.name }}" | |
| context: "./" | |
| push: false | |
| load: true | |
| tags: "${{ env.PLUGIN_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}" | |
| file: "./development/Dockerfile" | |
| cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}" | |
| cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}" | |
| build-args: | | |
| NAUTOBOT_VER=${{ matrix.nautobot-version }} | |
| PYTHON_VER=${{ matrix.python-version }} | |
| - name: "Copy credentials" | |
| run: "cp development/creds.example.env development/creds.env" | |
| - name: "Use Mysql invoke settings when needed" | |
| run: "cp invoke.mysql.yml invoke.yml" | |
| if: "${{ matrix.db-backend == 'mysql' }}" | |
| - name: "Run Tests" | |
| run: "poetry run invoke unittest" | |
| publish_gh: | |
| needs: | |
| - "unittest" | |
| name: "Publish to GitHub" | |
| runs-on: "ubuntu-20.04" | |
| if: "startsWith(github.ref, 'refs/tags/v')" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Set up Python" | |
| uses: "actions/setup-python@v2" | |
| 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: "Install Dependencies (needed for mkdocs)" | |
| run: "poetry install" | |
| - name: "Build Documentation" | |
| run: "poetry run mkdocs build --no-directory-urls --strict" | |
| - name: "Run Poetry Build" | |
| run: "poetry build" | |
| - name: "Upload binaries to release" | |
| uses: "svenstaro/upload-release-action@v2" | |
| with: | |
| repo_token: "${{ secrets.GH_NAUTOBOT_BOT_TOKEN }}" | |
| file: "dist/*" | |
| tag: "${{ github.ref }}" | |
| overwrite: true | |
| file_glob: true | |
| publish_pypi: | |
| needs: | |
| - "unittest" | |
| name: "Push Package to PyPI" | |
| runs-on: "ubuntu-20.04" | |
| if: "startsWith(github.ref, 'refs/tags/v')" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Set up Python" | |
| uses: "actions/setup-python@v2" | |
| 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: "Install Dependencies (needed for mkdocs)" | |
| run: "poetry install" | |
| - name: "Build Documentation" | |
| run: "poetry run mkdocs build --no-directory-urls --strict" | |
| - name: "Run Poetry Build" | |
| run: "poetry build" | |
| - name: "Push to PyPI" | |
| uses: "pypa/gh-action-pypi-publish@release/v1" | |
| with: | |
| user: "__token__" | |
| password: "${{ secrets.PYPI_API_TOKEN }}" | |
| slack-notify: | |
| needs: | |
| - "publish_gh" | |
| - "publish_pypi" | |
| runs-on: "ubuntu-20.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/[email protected]" | |
| with: | |
| payload: | | |
| { | |
| "blocks": [ | |
| { | |
| "type": "section", | |
| "text": { | |
| "type": "mrkdwn", | |
| "text": "${{ env.SLACK_MESSAGE }}" | |
| } | |
| } | |
| ] | |
| } | |
| env: | |
| SLACK_WEBHOOK_URL: "${{ secrets.SLACK_WEBHOOK_URL }}" | |
| SLACK_WEBHOOK_TYPE: "INCOMING_WEBHOOK" |