Fixed mkdocsignore and improved DevExp (#24)

- improved dev experience
- pre-commit and better linting handling
- fixed mkdocsignore (close #28)
- added 3rd party plugins compatibility
- poetry-dynamic-versioning support
- added GitHub Dependency Review support

Author: DariuszPorowski

.devcontainer/devcontainer.json

@@ -36,7 +36,8 @@
 				"ms-python.python",
 				"ms-python.vscode-pylance",
 				"ms-python.isort",
-				"yzhang.markdown-all-in-one"
+				"yzhang.markdown-all-in-one",
+				"charliermarsh.ruff"
 			]
 		}
 	}

.editorconfig

@@ -6,17 +6,14 @@ end_of_line = lf
 trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = tab
+indent_size = 2
 
 [*.{cmd,bat}]
 end_of_line = crlf
 
 [*.{yml,yaml,pages,md,markdown}]
 indent_style = space
-indent_size = 2
 
 [*.py]
 indent_style = space
 indent_size = 4
-
-[*.json]
-indent_size = 2

.file-filter.yml

@@ -2,18 +2,28 @@
 # include_glob:
 #   - "test/test.md"
 #   - "**/draft-*.md"
-# exclude_glob:
-#   - "Contributions/**"
 # include_tag:
 #   - foo
 #   - "#bar"
 # exclude_tag:
-#   - test
+#   - "#bar"
 
-only_doc_pages: true # default value is false
-exclude_regex:
-  - '.*\.md$'
-include_regex:
-  - "tags.md"
+# INCLUDE ONLY DOC TAGED WITH 'released'
+# only_doc_pages: true
+# exclude_regex:
+#   - '.*\.md$'
+# include_tag:
+#   - released
+
+only_doc_pages: true
+mkdocsignore: true
+exclude_glob:
+  - "**/draft-*.md"
+  - "**/preview-*.md"
 include_tag:
   - released
+  - public preview
+exclude_tag:
+  - draft
+include_regex:
+  - "tags.md"

.flake8

@@ -1,3 +1,3 @@
 [flake8]
-max-line-length = 88
+max-line-length = 120
 exclude = .git,__pycache__,.tox,.eggs,*.egg,.venv

.github/workflows/workflow.ci.yml

@@ -21,12 +21,30 @@ on:
 
 # Allow one concurrent
 concurrency:
-  group: pr-${{ github.ref }}
+  group: ${{ format('{0}-{1}', github.event_name, github.ref) }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
+  dependency-review:
+    if: ${{ github.event_name == 'pull_request' && !github.event.pull_request.draft }}
+    name: Dependency Review
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Run Dependency Review
+        uses: actions/dependency-review-action@v3
+        with:
+          comment-summary-in-pr: true
+
   lint:
-    if: ${{ !github.event.pull_request.draft }}
+    if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && !github.event.pull_request.draft) }}
     name: Lint
     runs-on: ubuntu-latest
     steps:
@@ -39,29 +57,41 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
-          cache: "poetry"
+          python-version-file: .python-version
+          cache: poetry
 
       - name: Install dependencies
-        run: poetry install --verbose --only=dev
+        run: |
+          poetry self add "poetry-dynamic-versioning[plugin]"
+          poetry install --verbose --all-extras --only=dev
+
+      # - name: Run ruff
+      #   run: poetry run ruff -v check .
 
-      - name: Check imports sort
-        run: poetry run isort --profile black --check-only .
+      - name: Run mypy
+        run: poetry run mypy --config-file pyproject.toml
 
-      - name: Check formatting
-        run: poetry run black --check .
+      - name: Run isort
+        run: poetry run isort --settings-path pyproject.toml --check-only .
 
-      - name: Check formatting
+      - name: Run black
+        run: poetry run black --config pyproject.toml --check .
+
+      - name: Run flake8
         run: poetry run flake8 --count .
 
-  test:
-    if: ${{ !github.event.pull_request.draft }}
-    name: Test
-    needs: lint
+      - name: Run bandit
+        run: poetry run bandit --configfile pyproject.toml --recursive .
+
+  test-self:
+    if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && !github.event.pull_request.draft) }}
+    name: Test (self)
+    needs:
+      - lint
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -75,18 +105,45 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          cache: "poetry"
+          cache: poetry
 
       - name: Install dependencies
-        run: poetry install --verbose
+        run: |
+          poetry self add "poetry-dynamic-versioning[plugin]"
+          poetry install --verbose --without=dev
 
       - name: Test Build
-        run: |
-          poetry version --verbose
-          poetry build --verbose
+        run: poetry build --verbose
 
       - name: Test MkDocs build
+        run: poetry run mkdocs build --verbose
+
+  test-plugins:
+    if: ${{ github.event_name == 'pull_request' && !github.event.pull_request.draft }}
+    name: Test (plugins)
+    needs:
+      - test-self
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Install Poetry
+        run: pipx install poetry
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version-file: .python-version
+          cache: poetry
+
+      - name: Install dependencies
         run: |
-          pip uninstall -y mkdocs_file_filter_plugin
-          pip install dist/mkdocs_file_filter_plugin-0.0.1.tar.gz
-          poetry run mkdocs build --verbose
+          poetry self add "poetry-dynamic-versioning[plugin]"
+          poetry install --verbose --without=dev
+
+      - name: Test Build
+        run: poetry build --verbose
+
+      - name: Test MkDocs build
+        run: poetry run mkdocs build --verbose --config-file mkdocs.plugins.yml

.github/workflows/workflow.release.draft.yml

@@ -21,7 +21,7 @@ jobs:
         uses: release-drafter/release-drafter@v5
         id: release-drafter
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ github.token }}
 
       - name: Release URL
         run: |

.github/workflows/workflow.release.yml

@@ -26,14 +26,16 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
-          cache: "poetry"
+          python-version: .python-version
+          cache: poetry
 
       - name: Install dependencies
-        run: poetry install --verbose
+        run: |
+          poetry self add "poetry-dynamic-versioning[plugin]"
+          poetry install --verbose --without=dev
 
-      - name: Set Version
-        run: poetry version ${GITHUB_REF_NAME/v/}
+      # - name: Set Version
+      #   run: poetry version ${GITHUB_REF_NAME/v/}
 
       - name: Build
         run: poetry build --verbose

.gitignore

@@ -88,7 +88,7 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
+# .python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -108,13 +108,13 @@ celerybeat.pid
 *.sage.py
 
 # Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
+# .env
+# .venv
+# env/
+# venv/
+# ENV/
+# env.bak/
+# venv.bak/
 
 # Spyder project settings
 .spyderproject
@@ -133,3 +133,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Ruff cache
+.ruff_cache

.markdownlint.json

@@ -1,4 +1,4 @@
 {
 	"ignore_front_matter": true,
 	"MD013": false
-}
+}

.mkdocsignore

@@ -1,3 +1,2 @@
 # MkDocs
-# docs/test/**
 docs/**/draft-*.md