Merge pull request #12 from PhilipPartsch/merge_from_template

merge content from template repo

.github/workflows/builddoc.yml

@@ -32,9 +32,13 @@ jobs:
         python-version: "3"
         cache: 'pip' # caching pip dependencies
     - name: print versions for debugging
-      run: python --version ; pip --version ; whoami
+      run: python --version ; pip --version ; whoami ; pwd
     - name: Install graphviz & default-jdk
-      run: sudo apt-get install graphviz default-jdk
+      run: |
+        sudo apt-get update
+        sudo apt-get upgrade --yes
+        sudo apt-get install graphviz default-jdk
+        sudo apt-get upgrade --yes
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -44,6 +48,11 @@ jobs:
     - name: Lint the project with sphinx-lint
       run: |
         sphinx-lint
+    - name: Lint the project with vale
+      uses: errata-ai/[email protected]
+      with:
+        # github-pr-check, github-pr-review, github-check
+        reporter: github-check
     - name: Test with pytest
       run: |
         coverage run --branch --data-file=./docs/_static/_external_data/coverage.file -m pytest ./tests/ --junitxml=./docs/_static/_external_data/merge_dicts_test_results.xml --report-log=./docs/_static/_external_data/merge_dicts_test_log.json
@@ -70,9 +79,6 @@ jobs:
           ./docs/_static/_external_data/coverage_html
       # Use always() to always run this step to publish test results when there are test failures
       if: ${{ always() }}
-    - name: Setup Pages
-      id: pages
-      uses: actions/configure-pages@v5
     - name: Render the documentation
       run: >
         sphinx-build
@@ -82,10 +88,13 @@ jobs:
         --show-traceback
         --fail-on-warning
         --keep-going
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v3
+    - name: Archive sphinx public folder
+      uses: actions/upload-artifact@v4
       with:
-        path: ./public
+        name: sphinx-public
+        path: |
+          ./public/
+
 
   # Deployment job
   deploy:
@@ -96,6 +105,19 @@ jobs:
     needs: build
     if: github.ref == 'refs/heads/main'
     steps:
+      - name: Download sphinx public folder
+        uses: actions/download-artifact@v4
+        with:
+          name: sphinx-public
+          path: ./public/
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./public
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
+

.vale.ini

@@ -0,0 +1,13 @@
+StylesPath = styles
+MinAlertLevel = suggestion
+
+Packages = proselint, Joblint
+# write-good, Google, Microsoft, alex, Joblint
+
+# Here's were we define the exceptions to use in *all* `BasedOnStyles`.
+Vocab = merge_dicts
+
+[*.rst]
+BasedOnStyles = Vale, proselint, Joblint
+# write-good, Google, Microsoft, alex, Joblint
+

.vscode/settings.json

@@ -4,9 +4,10 @@
    "files.trimTrailingWhitespace": true,
 
    "editor.rulers": [
-       80
+       100
    ],
    "editor.tabSize": 3,
    "editor.renderWhitespace": "all",
 
-}
+}
+

docs/_tools/readme.rst

@@ -1,10 +1,13 @@
 Tools
 =====
 
-Here we collect binary tools which do not support code import.
+Here we collect binary tools which don't support code import.
+
+Please pay attention, if you want to execute a tool in a pipeline,
+you have to set the execution bit for UNIX OS based systems.
 
-Please pay attention, if you want to execute a tool in a pipeline, you have to set the execution bit for UNIX OS based systems.
 | Please do so with:
 | `git update-index --chmod=+x path/to/tool`
 
 and normal git commit handling.
+

docs/index.rst

@@ -1,4 +1,4 @@
-.. include:: ../README.rst
+.. include:: ../readme.rst
 
 **merge_dicts** is a Python library to merge `dictionaries
 <https://docs.python.org/3/tutorial/datastructures.html#dictionaries>`_.

docs/requirements.txt

@@ -1,3 +1,4 @@
+vale
 sphinx==7.4.7
 sphinxcontrib.jquery
 sphinxcontrib-plantuml

README.rst → readme.rst

@@ -19,6 +19,6 @@ This side is been hosted on:
 
 - GitLab
    - Repository: https://gitlab.com/PhilipPartsch/reconf2023-product-as-code
-   - Gitlab Pipeline: https://gitlab.com/PhilipPartsch/reconf2023-product-as-code/-/pipelines
-   - Gitlab Pipeline Script: https://gitlab.com/PhilipPartsch/reconf2023-product-as-code/-/blob/main/.gitlab-ci.yml
+   - GitLab Pipeline: https://gitlab.com/PhilipPartsch/reconf2023-product-as-code/-/pipelines
+   - GitLab Pipeline Script: https://gitlab.com/PhilipPartsch/reconf2023-product-as-code/-/blob/main/.gitlab-ci.yml
    - GitLab hosted documentation: https://reconf2023-product-as-code-philippartsch-a4d4571b1b7e4136d3bdb6.gitlab.io

styles/config/vocabularies/merge_dicts/accept.txt

@@ -0,0 +1,5 @@
+html
+rst
+xml
+json
+merge_dicts