Update docs/dev/dev_config.md #122
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 | |
| - "push" | |
| - "pull_request" | |
| env: | |
| IMAGE_NAME: "netutils" | |
| jobs: | |
| black: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| with: | |
| python-version: "3.11" | |
| - name: "Linting: black" | |
| run: "poetry run invoke black" | |
| bandit: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| with: | |
| python-version: "3.11" | |
| - name: "Linting: bandit" | |
| run: "poetry run invoke bandit" | |
| needs: | |
| - "black" | |
| mypy: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| with: | |
| python-version: "3.11" | |
| - name: "Type-Hints: mypy" | |
| run: "poetry run invoke mypy" | |
| needs: | |
| - "black" | |
| pydocstyle: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| with: | |
| python-version: "3.11" | |
| - name: "Linting: pydocstyle" | |
| run: "poetry run invoke pydocstyle" | |
| needs: | |
| - "black" | |
| flake8: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| with: | |
| python-version: "3.11" | |
| - name: "Linting: flake8" | |
| run: "poetry run invoke flake8" | |
| needs: | |
| - "black" | |
| yamllint: | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| INVOKE_LOCAL: "True" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| with: | |
| python-version: "3.11" | |
| - name: "Linting: yamllint" | |
| run: "poetry run invoke yamllint" | |
| needs: | |
| - "black" | |
| build: | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11"] | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| PYTHON_VER: "${{ matrix.python-version }}" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Get image version" | |
| run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV" | |
| - 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 | |
| tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}" | |
| file: "./Dockerfile" | |
| cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}" | |
| cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}" | |
| build-args: | | |
| PYTHON_VER=${{ env.PYTHON_VER }} | |
| needs: | |
| - "bandit" | |
| - "mypy" | |
| - "pydocstyle" | |
| - "flake8" | |
| - "yamllint" | |
| pylint: | |
| runs-on: "ubuntu-20.04" | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.11"] | |
| env: | |
| PYTHON_VER: "${{ matrix.python-version }}" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Get image version" | |
| run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV" | |
| - name: "Set up Docker Buildx" | |
| id: "buildx" | |
| uses: "docker/setup-buildx-action@v1" | |
| - name: "Load the image from cache" | |
| uses: "docker/build-push-action@v2" | |
| with: | |
| builder: "${{ steps.buildx.outputs.name }}" | |
| context: "./" | |
| push: false | |
| load: true | |
| tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}" | |
| file: "./Dockerfile" | |
| cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}" | |
| cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.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: | |
| - "build" | |
| pytest: | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11"] | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| PYTHON_VER: "${{ matrix.python-version }}" | |
| steps: | |
| - name: "Check out repository code" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup environment" | |
| uses: "networktocode/gh-action-setup-poetry-environment@v2" | |
| - name: "Get image version" | |
| run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV" | |
| - name: "Set up Docker Buildx" | |
| id: "buildx" | |
| uses: "docker/setup-buildx-action@v1" | |
| - name: "Load the image from cache" | |
| uses: "docker/build-push-action@v2" | |
| with: | |
| builder: "${{ steps.buildx.outputs.name }}" | |
| context: "./" | |
| push: false | |
| load: true | |
| tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}" | |
| file: "./Dockerfile" | |
| cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}" | |
| cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.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" | |
| - name: "Install Optional Dependencies" | |
| run: "poetry run poetry install --extras optionals" | |
| - name: "Run Optional Tests" | |
| run: "poetry run pytest tests/unit/test_lib_helpers_optionals.py tests/unit/test_acl.py" | |
| needs: | |
| - "pylint" | |
| publish_gh: | |
| 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.11" | |
| - 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: "Upload binaries to release" | |
| uses: "svenstaro/upload-release-action@v2" | |
| with: | |
| repo_token: "${{ secrets.NTC_GITHUB_TOKEN }}" | |
| file: "dist/*" | |
| tag: "${{ github.ref }}" | |
| overwrite: true | |
| file_glob: true | |
| needs: | |
| - "pytest" | |
| publish_pypi: | |
| 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.11" | |
| - 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@release/v1" | |
| with: | |
| user: "__token__" | |
| password: "${{ secrets.PYPI_API_TOKEN }}" | |
| needs: | |
| - "pytest" |