Release 0.8.0 (#102)

- Added documentation with MkDocs. Documentation contains multiple guides for new users and full autogenerated package reference. - Changed command line interface. Now `cssfinder project` commands no longer auto-detect project as current working directory. - Added JSON report format.
Argmaster · Apr 16, 2024 · b9ce570 · b9ce570
2 parents c50a09c + f8309fe
commit b9ce570
Show file tree

Hide file tree

Showing 62 changed files with 4,620 additions and 2,729 deletions.
diff --git a/.github/workflows/build_n_deploy_docs.yaml b/.github/workflows/build_n_deploy_docs.yaml
@@ -0,0 +1,53 @@
+---
+name: Build & Deploy Docs
+
+on:
+  push:
+    tags:
+      - "v*"
+
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.action_path }}-${{ github.ref }}-build-n-deploy-docs
+  cancel-in-progress: false
+
+jobs:
+  run-build-n-deploy-docs:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.8"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3.6.0
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4.7.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: "x64"
+
+      - name: Install Poetry
+        run: pip install poetry==1.8.2
+
+      - name: Install dependencies
+        run: poetry install --with=docs --no-cache --sync
+
+      - name: Install Mike
+        run: poetry run pip install mike
+
+      - name: Configure Git
+        run: |
+          git config user.name github-actions
+          git config user.email argmaster.world@gmail.com
+
+      - name: Run build & deploy documentation
+        run: |
+          poetry run mike deploy --push --update-aliases $(poetry version | awk '{ print $2 }') latest -F mkdocs.yaml
diff --git a/.github/workflows/code_quality.yaml b/.github/workflows/code_quality.yaml
@@ -55,7 +55,7 @@ jobs:
           architecture: "x64"
 
       - name: Install Poetry
-        run: pip install poetry==1.4.0
+        run: pip install poetry==1.8.2
 
       - name: Install dependencies
         run: poetry install --no-cache --sync

diff --git a/.github/workflows/deploy_to_pypi.yaml b/.github/workflows/deploy_to_pypi.yaml
@@ -26,7 +26,7 @@ jobs:
           architecture: "x64"
 
       - name: Install Poetry 📜
-        run: pip install poetry==1.4.0
+        run: pip install poetry==1.8.2
 
       - name: Install dependencies 🗄️
         run: poetry install --no-cache --sync

diff --git a/.github/workflows/deploy_to_test_pypi.yaml b/.github/workflows/deploy_to_test_pypi.yaml
@@ -25,7 +25,7 @@ jobs:
           architecture: "x64"
 
       - name: Install Poetry 📜
-        run: pip install poetry==1.4.0
+        run: pip install poetry==1.8.2
 
       - name: Install dependencies 🗄️
         run: poetry install --no-cache --sync
@@ -44,13 +44,6 @@ jobs:
         run: |
           echo "version=$(poetry version | awk '{ print $2 }')" >> $GITHUB_OUTPUT
 
-      - name: Create development 🔨 Tag 🏷️
-        id: tag-version
-        uses: mathieudutour/github-tag-action@v6.1
-        with:
-          custom_tag: ${{ steps.project-version.outputs.version }}
-          github_token: ${{ secrets.REPO_ACCESS_TOKEN }}
-
       - name: Publish distribution 📦 to Test PyPI
         # Executed always
         uses: pypa/gh-action-pypi-publish@release/v1

diff --git a/.github/workflows/reports_tests.yaml b/.github/workflows/reports_tests.yaml
@@ -39,7 +39,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
+        os: [ubuntu-latest, windows-latest]
         python-version: ["3.8", "3.9", "3.10"]
 
     runs-on: ${{ matrix.os }}
@@ -55,7 +55,7 @@ jobs:
           architecture: "x64"
 
       - name: Install Poetry
-        run: pip install poetry==1.4.0
+        run: pip install poetry==1.8.2
 
       - name: Install dependencies
         run: poetry install --no-cache --sync

diff --git a/.github/workflows/system_tests.yaml b/.github/workflows/system_tests.yaml
@@ -55,7 +55,7 @@ jobs:
           architecture: "x64"
 
       - name: Install Poetry
-        run: pip install poetry==1.4.0
+        run: pip install poetry==1.8.2
 
       - name: Install dependencies
         run: poetry install --no-cache --sync

diff --git a/.github/workflows/type_check.yaml b/.github/workflows/type_check.yaml
@@ -55,7 +55,7 @@ jobs:
           architecture: "x64"
 
       - name: Install Poetry
-        run: pip install poetry==1.4.0
+        run: pip install poetry==1.8.2
 
       - name: Install dependencies
         run: poetry install --no-cache --sync

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,29 +1,5 @@
 exclude: '^(\.tox|\.env|dist|\.vscode)(/|$)'
 repos:
-  - repo: https://github.com/Argmaster/autocopyright
-    rev: "v1.1.0"
-    hooks:
-      - id: autocopyright
-        args:
-          [
-            -s,
-            "#",
-            -d,
-            cssfinder,
-            -d,
-            test,
-            -d,
-            scripts,
-            -d,
-            examples,
-            -g,
-            "*.py",
-            -g,
-            "*.pyi",
-            -l,
-            "./scripts/templates/MIT.md.jinja2",
-          ]
-
   - repo: https://github.com/PyCQA/autoflake
     rev: "v2.0.1"
     hooks:
@@ -58,17 +34,6 @@ repos:
     hooks:
       - id: prettier
 
-  - repo: https://github.com/timothycrosley/isort
-    rev: "5.12.0"
-    hooks:
-      - id: isort
-
-  - repo: https://github.com/timothycrosley/isort
-    rev: "5.12.0"
-    hooks:
-      - id: isort
-        args: [-a, "from __future__ import annotations", cssfinder]
-
   - repo: https://github.com/ambv/black
     rev: "23.3.0"
     hooks:
@@ -94,7 +59,7 @@ repos:
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     # Ruff version.
-    rev: "v0.0.254"
+    rev: "v0.3.7"
     hooks:
       - id: ruff
         args: ["--fix"]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 NOTE: CSSFinder follows the [semver](https://semver.org/) versioning standard.
 
+### 0.8.0 - April 17, 2024
+
+- Added documentation with MkDocs. Documentation contains multiple guides for
+  new users and full autogenerated package reference.
+- Changed command line interface. Now `cssfinder project` commands no longer
+  auto-detect project as current working directory.
+- Added JSON report format.
+
 ### 0.7.0 - May 19, 2023
 
 - Added G3PaE3qD mode support.