only_doc_pages (#13)

close #14

Author: DariuszPorowski

.devcontainer/devcontainer.json

@@ -31,8 +31,12 @@
 			"extensions": [
 				"EditorConfig.EditorConfig",
 				"GitHub.vscode-pull-request-github",
-				"yzhang.markdown-all-in-one",
-				"ms-vscode-remote.vscode-remote-extensionpack"
+				"ms-vscode-remote.vscode-remote-extensionpack",
+				"ms-vscode-remote.remote-containers",
+				"ms-python.python",
+				"ms-python.vscode-pylance",
+				"ms-python.isort",
+				"yzhang.markdown-all-in-one"
 			]
 		}
 	}

.editorconfig

@@ -10,10 +10,13 @@ indent_style = tab
 [*.{cmd,bat}]
 end_of_line = crlf
 
-[*.{yml,yaml,md,pages}]
+[*.{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

@@ -1,11 +1,19 @@
-mkdocsignore: false
-include_glob:
-  - 'test/test.md'
-  - '**/draft-*.md'
-exclude_glob:
-  - 'Contributions/**'
+# mkdocsignore: false
+# include_glob:
+#   - "test/test.md"
+#   - "**/draft-*.md"
+# exclude_glob:
+#   - "Contributions/**"
+# include_tag:
+#   - foo
+#   - "#bar"
+# exclude_tag:
+#   - test
+
+only_doc_pages: true # default value is false
+exclude_regex:
+  - '.*\.md$'
+include_regex:
+  - "tags.md"
 include_tag:
-  - foo
-  - '#bar'
-exclude_tag:
-  - test
+  - released

.flake8

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

.github/CODEOWNERS

@@ -1,2 +1,2 @@
-# Default reviewers/codeowners for all code changes
+# Default reviewers/codeowners for all code changes in the repository
 * @DariuszPorowski

.github/workflows/workflow.pr.yml .github/workflows/workflow.ci.yml.github/workflows/workflow.pr.yml renamed to .github/workflows/workflow.ci.yml

@@ -1,9 +1,20 @@
 ---
-name: Pull Request checker
+name: CI
 on:
+  push:
+    branches:
+      - main
   pull_request:
+    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
     branches:
       - main
+    paths:
+      - "mkdocs_file_filter_plugin/**"
 
 # Allow one concurrent
 concurrency:
@@ -12,6 +23,7 @@ concurrency:
 
 jobs:
   lint:
+    if: ${{ !github.event.pull_request.draft }}
     name: Lint
     runs-on: ubuntu-latest
     steps:
@@ -28,7 +40,7 @@ jobs:
           cache: "poetry"
 
       - name: Install dependencies
-        run: poetry install --only=dev
+        run: poetry install --verbose --only=dev
 
       - name: Check imports sort
         run: poetry run isort --check-only .
@@ -40,6 +52,7 @@ jobs:
         run: poetry run flake8 --count .
 
   test:
+    if: ${{ !github.event.pull_request.draft }}
     name: Test
     needs: lint
     strategy:
@@ -62,11 +75,11 @@ jobs:
           cache: "poetry"
 
       - name: Install dependencies
-        run: poetry install
+        run: poetry install --verbose
 
       - name: Test Build
         run: |
-          poetry version
+          poetry version --verbose
           poetry build --verbose
 
       - name: Test MkDocs build

.github/workflows/workflow.release.yml

@@ -2,15 +2,16 @@
 name: Release
 
 on:
-  release:
-    types:
-      - prereleased
-      - released
-      - published
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
 
 jobs:
-  release:
-    if: ${{ !github.event.release.prerelease && github.event.action == 'released' && github.repository_owner == 'DariuszPorowski' }}
+  pypi-release:
+    name: PyPI Release
     environment:
       name: PyPI
       url: "https://pypi.org/project/mkdocs-file-filter-plugin"
@@ -29,13 +30,44 @@ jobs:
           cache: "poetry"
 
       - name: Install dependencies
-        run: poetry install
+        run: poetry install --verbose
 
       - name: Set Version
         run: poetry version ${GITHUB_REF_NAME/v/}
 
       - name: Build
-        run: poetry build
+        run: poetry build --verbose
+
+      - name: Publish to PyPI
+        run: poetry publish --verbose --username=__token__ --password ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: plugin
+          path: |
+            dist/*
+            schema*.json
+
+  gh-release:
+    name: GitHub Release
+    needs: pypi-release
+    environment:
+      name: GitHub
+      url: ${{ steps.gh-release.outputs.url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: plugin
+          path: .
 
-      - name: Publish
-        run: poetry publish --username=__token__ --password ${{ secrets.PYPI_API_TOKEN }}
+      - name: Release
+        id: gh-release
+        uses: softprops/action-gh-release@v1
+        with:
+          generate_release_notes: true
+          files: |
+            dist/*
+            schema*.json

.markdownlint.json

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

.pre-commit-config.yaml

@@ -2,16 +2,16 @@ repos:
   - repo: https://github.com/psf/black
     rev: 23.1.0
     hooks:
-    - id: black
+      - id: black
   - repo: https://github.com/PyCQA/isort
     rev: 5.12.0
     hooks:
-    - id: isort
+      - id: isort
   - repo: https://github.com/pycqa/flake8
     rev: 6.0.0
     hooks:
-    - id: flake8
+      - id: flake8
   - repo: https://github.com/PyCQA/bandit
     rev: 1.7.4
     hooks:
-    - id: bandit
+      - id: bandit

.vscode/extensions.json

@@ -0,0 +1,13 @@
+{
+	// See http://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+		"EditorConfig.EditorConfig",
+		"ms-vscode-remote.remote-containers",
+		"ms-python.python",
+		"ms-python.vscode-pylance",
+		"ms-python.isort",
+		"yzhang.markdown-all-in-one"
+	]
+}