Rebase against upstream

.gitattributes

@@ -2,6 +2,11 @@
 CHANGELOG.md merge=union
 
 *.xlsx binary
+*.min.js binary
+*.min.css binary
+doorstop/core/files/templates/html/output/*.js binary
+doorstop/core/files/templates/html/tex-mml-chtml.js binary
+doorstop/core/tests/files/published*.html binary
 
 # Python, Git, and Cygwin have different ideas about the correct line endings
 *.yml  -text

.github/release.yml

@@ -0,0 +1,13 @@
+changelog:
+  categories:
+    - title: Features
+      labels:
+        - '*'
+      exclude:
+        labels:
+          - dependencies
+    - title: Dependencies
+      labels:
+        - dependencies
+
+

.github/workflows/change-coverage.yml

@@ -24,10 +24,10 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.12"
           architecture: x64
 
-      - uses: Gr1N/setup-poetry@v8
+      - uses: Gr1N/setup-poetry@v9
 
       - name: Check system dependencies
         run: make doctor
@@ -43,6 +43,6 @@ jobs:
       - name: Check coverage
         run: |
           TEST_INTEGRATION=true poetry run pytest doorstop --doctest-modules --cov=doorstop --cov-report=xml --cov-report=term-missing
-          git fetch origin develop:develop
+          git fetch origin main:main
           # TEST_INTEGRATION=true poetry run diff-cover ./coverage.xml --fail-under=100 --compare-branch=develop
-          TEST_INTEGRATION=true poetry run diff-cover ./coverage.xml --fail-under=100 --compare-branch=$(git for-each-ref --sort=-committerdate refs/heads/develop | cut -f 1 -d ' ')
+          TEST_INTEGRATION=true poetry run diff-cover ./coverage.xml --fail-under=100 --compare-branch=$(git for-each-ref --sort=-committerdate refs/heads/main | cut -f 1 -d ' ')

.github/workflows/execute-tests.yml

@@ -11,14 +11,17 @@ on:
       workpath:
         required: true
         type: string
+    secrets:
+      CODECOV_TOKEN:
+        required: true
 
 jobs:
   test:
     runs-on: ${{ inputs.os }}
     strategy:
-      fail-fast: false
+      fail-fast: true
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12"]
     name: Python ${{ matrix.python-version }}
 
     defaults:
@@ -43,7 +46,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
           architecture: x64
 
-      - uses: Gr1N/setup-poetry@v8
+      - uses: Gr1N/setup-poetry@v9
 
       - name: Check system dependencies
         run: make doctor
@@ -67,11 +70,12 @@ jobs:
           current_path: ${{ inputs.workpath }}
           attempt_limit: 5
           attempt_delay: 2000
-      - name: Upload coverage
-        uses: codecov/codecov-action@v1
-        if: ${{ inputs.os == 'ubuntu-latest' && matrix.python-version == '3.9' && github.repository == 'doorstop-dev/doorstop' }}
-        with:
-          fail_ci_if_error: true
+          #
+      # - name: Upload coverage
+      #   uses: codecov/codecov-action@v1
+      #   if: ${{ inputs.os == 'ubuntu-latest' && matrix.python-version == '3.10' && github.repository == 'doorstop-dev/doorstop' }}
+      #   with:
+      #     fail_ci_if_error: true
 
       - name: Run checks
         run: make check

.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Codethink Doorstop Release
+
+on:
+  push:
+    tags: 
+      - "v3.*"
+
+jobs:
+  tests:
+    uses: ./.github/workflows/execute-tests.yml
+    with:
+      os: "ubuntu-latest"
+      workpath: "/home/runner/work/doorstop/doorstop"
+
+  build-and-upload:
+    needs: tests
+    name: Build and Upload
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: write
+    strategy:
+      matrix:
+       python: ["3.10", "3.11", "3.12"]
+       os:
+          - ubuntu-latest
+          # - macos-latest
+          # - windows-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - uses: Gr1N/setup-poetry@v9
+
+      - run: poetry version ${{ github.ref_name }}
+        name: Set poetry version
+
+      - name: Build wheels and sdist (tarball)
+        run: make dist
+
+      - uses: actions/cache@v4
+        with:
+          path: .venv
+          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+
+      - name: Create Github Release
+        uses: softprops/action-gh-release@v2
+        if: ${{ matrix.python == '3.12' && matrix.os == 'ubuntu-latest'}}
+        with:
+          files: |
+                dist/*.whl
+                dist/*.tar.gz
+          tag_name: ${{ github.ref_name }}
+
+

.github/workflows/test-linux.yml

@@ -1,18 +1,26 @@
 name: Linux
 
 on:
-  push:
   pull_request:
-    branches: [ develop ]
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - edited
+    branches: [ main ]
 
 jobs:
   Coverage:
     uses: ./.github/workflows/change-coverage.yml
     with:
       os: "ubuntu-latest"
       workpath: "/home/runner/work/doorstop/doorstop"
+    if: github.event_name == 'pull_request'
+
   Test:
     uses: ./.github/workflows/execute-tests.yml
     with:
       os: "ubuntu-latest"
       workpath: "/home/runner/work/doorstop/doorstop"
+    secrets:
+      CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

.github/workflows/test-osx.yml

@@ -1,13 +1,14 @@
 name: macOS
 
 on:
-  push:
   pull_request:
-    branches: [ develop ]
+    branches: [ main ]
 
 jobs:
   Test:
     uses: ./.github/workflows/execute-tests.yml
     with:
-      os: "macos-latest"
+      os: "macos-13"
       workpath: "/Users/runner/work/doorstop/doorstop"
+    secrets:
+      CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

.github/workflows/test-osx.yml.disabled

@@ -0,0 +1,12 @@
+# name: macOS
+#
+# on:
+#   pull_request:
+#     branches: [ main ]
+#
+# jobs:
+#   Test:
+#     uses: ./.github/workflows/execute-tests.yml
+#     with:
+#       os: "macos-latest"
+#       workpath: "/Users/runner/work/doorstop/doorstop"

.github/workflows/test-windows.yml

@@ -1,9 +1,13 @@
 name: Windows
 
 on:
-  push:
   pull_request:
-    branches: [ develop ]
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - edited
+    branches: [ main ]
 
 jobs:
   Test:
@@ -12,3 +16,5 @@ jobs:
       basepath: 'D:\'
       os: "windows-latest"
       workpath: 'C:\a\doorstop\doorstop'
+    secrets:
+      CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

.gitlab-ci.yml

@@ -0,0 +1,67 @@
+# Environment variables declared in the `variables` dictionary below
+# can be expanded in job definitions or before_script below
+#
+variables:
+  # Docker Images
+  CONTAINER_REGISTRY: "gitlab.codethink.co.uk:5000/safety/dockerfiles"
+
+  NODE_IMAGE_ID: "d7aad9b98608971d0b5620a99290f76845269c49"
+  NODE_CONTAINER: "${CONTAINER_REGISTRY}/node:${NODE_IMAGE_ID}"
+
+  DCS_CONTAINER_REGISTRY: "gitlab.codethink.co.uk:5000/safety"
+  DCS_CONTAINER_IMAGE_ID: "00f2e962522ecab4f1d7a3a95224ff8efd299a53"
+  DCS_CONTAINER: "${DCS_CONTAINER_REGISTRY}/dcs-toolchain:${DCS_CONTAINER_IMAGE_ID}"
+
+default:
+  image: "${DCS_CONTAINER}"
+  tags:
+    # Check the runners in https://gitlab.codethink.co.uk/groups/codethink/-/wikis/Internal-Gitlab-Runners
+    - sml.amd64
+  before_script:
+    - pip install poetry
+    - make install
+
+#
+# Declare the stages
+#
+stages:
+  - lint
+  - test
+  - build
+#
+# Workflow rules for controlling when pipelines are created.
+# For more details see https://docs.gitlab.com/ee/ci/yaml/workflow.html
+#
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_PIPELINE_SOURCE == "web"
+    - if: $CI_PIPELINE_SOURCE == "schedule"
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+
+###########################################################
+#                      Lint stage jobs                    #
+###########################################################
+
+#
+# General yaml linter, this recursively detects malformed YAML
+#
+lint-doorstop:
+  stage: lint
+  script:
+    - make check
+#
+# Validate the markdown for invalid links, using markdown-link-check, see:
+#
+#   https://github.com/tcort/markdown-link-check
+#
+test-doorstop:
+  stage: test
+  needs: [lint-doorstop]
+  script:
+    - make test
+
+build-doorstop:
+  stage: build
+  script:
+    - make dist

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+exclude: ^(doorstop|docs)/.*
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+  - repo: https://gitlab.codethink.co.uk/lorry-mirrors/github/doorstop-dev/doorstop
+    rev: codethink-tag-3.0b11
+    hooks:
+    -   id: check-doorstop-errors
+    -   id: check-unreviewed-items

.pylint.ini

@@ -419,4 +419,4 @@ known-third-party=enchant
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=Exception
+overgeneral-exceptions=builtins.Exception

.readthedocs.yaml

@@ -3,11 +3,11 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.9"
 
 mkdocs:
   configuration: mkdocs.yml
 
 python:
   install:
-  - requirements: docs/requirements.txt
+    - requirements: docs/requirements.txt

.tool-versions

@@ -1,2 +1,2 @@
-python 3.8.13
+python 3.9.17
 poetry 1.7.1

.verchew.ini

@@ -6,7 +6,7 @@ version = GNU Make
 [Python]
 
 cli = python
-version = 3.8 || 3.9 || 3.10 || 3.11 || 3.12
+version = 3.9 || 3.10 || 3.11 || 3.12
 
 [Poetry]
 
@@ -17,6 +17,6 @@ version = 1.7
 
 cli = dot
 cli_version_arg = -V
-version = 9
+version = 9 || 10
 optional = true
 message = This is only needed to generate UML diagrams for documentation.

.vscode/settings.json

@@ -13,12 +13,9 @@
     "prof/": true,
     "site/": true,
   },
-  "python.linting.enabled": true,
-  "python.linting.pylintEnabled": true,
-  "python.linting.pylintArgs": ["--rcfile", ".pylint.ini"],
-  "python.linting.mypyEnabled": true,
-  "python.linting.mypyArgs": ["--config-file", ".mypy.ini"],
-  "python.linting.pydocstyleEnabled": true,
+  "python.defaultInterpreterPath": ".venv/bin/python",
+  "pylint.args": ["--rcfile=.pylint.ini"],
+  "editor.formatOnSave": true,
   "cSpell.words": [
     "Autobuild",
     "basepath",

CHANGELOG.md

@@ -1,6 +1,18 @@
+# 3.0 (beta) Codethink 0.2
+
+- Allow references to hidden file paths
+- Bump package versions to address security issues
+
+# 3.0 (beta) Codethink 0.1
+
+- Add publish support for AsciiDoc output
+- Ability to define settings through `.doorstoprc.py`
+- Support for mkdocs-flavoured markdown
+- Dropped support to python 3.9
+
 # 3.0 (beta)
 
-- **BREAKING:** Dropped support for Python 3.6 and 3.7.
+- **BREAKING:** Dropped support for Python 3.6, 3.7, and 3.8.
 - **BREAKING:** Removed `--no-body-levels` option to `doorstop publish`.
 - Fixed overriding default attributes with `doorstop add`. ([@tangoalx](https://github.com/doorstop-dev/doorstop/pull/544))
 - Fixed encoding error with special characters on Windows. ([@urbasus](https://github.com/doorstop-dev/doorstop/pull/526))