diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml new file mode 100644 index 0000000..529f3ae --- /dev/null +++ b/.github/workflows/docs-check.yml @@ -0,0 +1,28 @@ +name: Documentation Check Before Merge + +on: + pull_request: + branches: + - main + +jobs: + check-docstrings: + runs-on: ubuntu-latest + + steps: + - name: Checkout Repository + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: "3.9" + + - name: Install Dependencies + run: | + pip install flake8 flake8-docstrings + + - name: Run Documentation Checks + run: | + flake8 --select=D sample.py + diff --git a/connect_routers.py b/connect_routers.py index f73be10..b9c1aa3 100644 --- a/connect_routers.py +++ b/connect_routers.py @@ -16,3 +16,5 @@ def connect_to_router(router): routers = load_router_details('routers.yaml')['routers'] for router in routers: connect_to_router(router) + +