plexdo 1.1.26__tar.gz → 2.0.3__tar.gz

{plexdo-1.1.26 → plexdo-2.0.3}/.github/workflows/ci.yml

@@ -1,3 +1,8 @@
+# SPDX-FileCopyrightText: 2026 SidusNare
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileContributor: Claude Opus 5.5 (AI-generated)
+
+---
 name: CI
 
 on:
@@ -26,10 +31,22 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      # markdownlint-cli2 needs Node 22 or newer; .nvmrc names the version.
+      - uses: actions/setup-node@v7
+        with:
+          node-version-file: .nvmrc
+
+      # make check lints with every tool the project requires: ShellCheck
+      # and yamllint from apt, reuse from PyPI (apt's is too old to read
+      # REUSE.toml), and markdownlint-cli2 at the version package.json pins.
+      # publish.yml installs the same, since it runs the same make check.
       - name: Install
         run: |
           python -m pip install --upgrade pip
-          pip install -e ".[dev]"
+          pip install -e ".[dev]" reuse
+          sudo apt-get update
+          sudo apt-get install -y shellcheck yamllint
+          npm ci
 
       - name: Full check
         run: make check

{plexdo-1.1.26 → plexdo-2.0.3}/.github/workflows/publish.yml

@@ -1,3 +1,8 @@
+# SPDX-FileCopyrightText: 2026 SidusNare
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileContributor: Claude Opus 5.5 (AI-generated)
+
+---
 name: Publish
 
 # Publishes to PyPI through Trusted Publishing (OIDC), so no API token is
@@ -40,13 +45,25 @@ jobs:
         with:
           python-version: "3.12"
 
+      # markdownlint-cli2 needs Node 22 or newer; .nvmrc names the version.
+      - uses: actions/setup-node@v7
+        with:
+          node-version-file: .nvmrc
+
+      # make check lints with every tool the project requires: ShellCheck
+      # and yamllint from apt, reuse from PyPI (apt's is too old to read
+      # REUSE.toml), and markdownlint-cli2 at the version package.json pins.
+      # ci.yml installs the same, since it runs the same make check.
       - name: Install
         run: |
           python -m pip install --upgrade pip
-          pip install -e ".[dev]"
+          pip install -e ".[dev]" reuse
+          sudo apt-get update
+          sudo apt-get install -y shellcheck yamllint
+          npm ci
 
       # Everything that gates a normal pull request also gates a release:
-      # version consistency across the three places it appears, packaged
+      # the man page and SBOM matching pyproject's version, packaged
       # assets matching their sources, the smoke test, the suite, pylint,
       # the build itself, and twine's metadata check.
       - name: Full check
@@ -55,17 +72,24 @@ jobs:
       # A release tagged v1.2.3 must contain version 1.2.3. Without this the
       # wheel would upload under whatever version the source happened to
       # carry, and PyPI would accept it: uploads are immutable, so the
-      # mistake could not be taken back.
+      # mistake could not be taken back. Compared as versions, not text: a
+      # tag is SemVer, v2.0.0-rc.1, and pyproject's PEP 440, 2.0.0rc1.
       - name: Tag matches package version
         if: github.event_name == 'release'
+        shell: python
         run: |
-          tag="${GITHUB_REF_NAME#v}"
-          version="$(python -c 'import plexdo; print(plexdo.__version__)')"
-          if [ "$tag" != "$version" ]; then
-            echo "::error::tag $GITHUB_REF_NAME does not match version $version"
-            exit 1
-          fi
-          echo "tag $GITHUB_REF_NAME matches version $version"
+          import os
+          import sys
+
+          from packaging.version import Version
+
+          import plexdo
+
+          tag = os.environ["GITHUB_REF_NAME"]
+          if Version(tag.removeprefix("v")) != Version(plexdo.__version__):
+              print(f"::error::tag {tag} does not match {plexdo.__version__}")
+              sys.exit(1)
+          print(f"tag {tag} matches version {plexdo.__version__}")
 
       # Exactly one job may upload a given artifact name: since v4 they are
       # immutable, so a second upload of "dist" would fail rather than merge.

plexdo-2.0.3/.github/workflows/wiki.yml

@@ -0,0 +1,135 @@
+# SPDX-FileCopyrightText: 2026 SidusNare
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileContributor: Claude Opus 5.5 (AI-generated)
+
+---
+name: Wiki
+
+# Publishes one GitHub wiki page per man/*.scd page: tools/wiki-pages.sh
+# converts each one scdoc -> roff -> pandoc -> GitHub-flavoured Markdown, and
+# man/plexdo-wait.1.scd becomes the wiki page plexdo-wait.
+#
+# One-time setup: enable the wiki under Settings > Features > Wikis, then
+# create its first page by hand. GitHub only creates the wiki's repository
+# at that point, and until it exists there is nothing to push to.
+#
+# Generated pages begin with a hidden "Generated from" comment. A page that
+# carries it and whose source has been removed is deleted; a page written by
+# hand never carries it and is never deleted. Editing a generated page on the
+# wiki is pointless: the next run overwrites it from its source.
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "man/*.scd"
+      - "tools/wiki-pages.sh"
+      - ".github/workflows/wiki.yml"
+  # Pull requests convert the pages without publishing them, so a page that
+  # does not compile, or refers to one that does not exist, fails review.
+  pull_request:
+    paths:
+      - "man/*.scd"
+      - "tools/wiki-pages.sh"
+      - ".github/workflows/wiki.yml"
+  # A full resync, for after the wiki has been edited by hand.
+  workflow_dispatch:
+
+# Converting the pages needs nothing more than reading the repository; only
+# the publish job raises its own permission, to push to the wiki.
+permissions:
+  contents: read
+
+# Two runs pushing to the wiki at once would race, the later failing on a
+# stale checkout; queue them instead of cancelling, so no update is lost.
+concurrency:
+  group: wiki
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install scdoc and pandoc
+        run: sudo apt-get update && sudo apt-get install -y scdoc pandoc
+
+      # Fails on a page scdoc rejects, and on a reference to a page that
+      # does not exist, rather than publishing a broken link.
+      - name: Convert
+        run: make wiki
+
+      - name: Upload pages
+        uses: actions/upload-artifact@v7
+        with:
+          name: wiki
+          path: build/wiki/
+          if-no-files-found: error
+
+  publish:
+    name: Publish to the wiki
+    needs: build
+    # Only what has reached main is published: a pull request, or a manual
+    # run from another branch, builds the pages and stops there.
+    if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write        # GITHUB_TOKEN pushes to the wiki under this
+    steps:
+      # Without this, a missing wiki surfaces as checkout's bare "repository
+      # not found", which does not say what to do about it.
+      - name: Wiki exists
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          wiki="https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.wiki.git"
+          if ! git ls-remote "$wiki" > /dev/null 2>&1; then
+            echo "::error::The wiki has no repository yet. Enable it under" \
+                 "Settings > Features > Wikis, create its first page by hand," \
+                 "and run this workflow again."
+            exit 1
+          fi
+
+      - name: Check out the wiki
+        uses: actions/checkout@v7
+        with:
+          repository: ${{ github.repository }}.wiki
+          path: wiki
+
+      - name: Download pages
+        uses: actions/download-artifact@v8
+        with:
+          name: wiki
+          path: pages/
+
+      - name: Sync pages
+        working-directory: wiki
+        run: |
+          # A generated page whose source is gone goes too. Only pages
+          # carrying the mark are candidates: hand-written ones never are.
+          for page in *.md; do
+            [ -e "$page" ] || continue
+            if head -n 1 "$page" | grep -q '^<!-- Generated from ' &&
+               [ ! -e "../pages/$page" ]; then
+              git rm --quiet "$page"
+              echo "removed $page"
+            fi
+          done
+
+          cp ../pages/*.md .
+          git add --all
+          if git diff --cached --quiet; then
+            echo "The wiki is already up to date."
+            exit 0
+          fi
+          git diff --cached --stat
+
+          bot="github-actions[bot]"
+          git config user.name "$bot"
+          git config user.email "41898282+$bot@users.noreply.github.com"
+          git commit --quiet \
+            -m "Update manual pages from ${GITHUB_SHA::7}" \
+            -m "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${GITHUB_SHA}"
+          git push

plexdo-2.0.3/.markdownlint-cli2.yaml

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2026 SidusNare
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileContributor: Claude Opus 5.5 (AI-generated)
+#
+#
+# markdownlint-cli2 configuration, following Google's Markdown style guide.
+---
+config:
+  # Each CHANGELOG release repeats the same Added/Changed/Fixed headings, so
+  # only headings that are siblings under one parent must differ.
+  MD024:
+    siblings_only: true
+  # Google's guide: 80 columns, except where a line cannot be broken, as in
+  # a code block or a table row.
+  MD013:
+    line_length: 80
+    code_blocks: false
+    tables: false
+globs:
+  - "**/*.md"
+ignores:
+  - "node_modules/**"
+  - "build/**"
+  - "dist/**"
+  # pytest writes a README of its own here while the tests run.
+  - ".pytest_cache/**"

plexdo-2.0.3/.nvmrc

@@ -0,0 +1 @@
+24

plexdo-2.0.3/.yamllint.yaml

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2026 SidusNare
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileContributor: Claude Opus 5.5 (AI-generated)
+#
+#
+# yamllint configuration: the default rules, at Google's 80 columns.
+---
+extends: default
+
+ignore: |
+  node_modules/
+  build/
+  dist/
+
+rules:
+  line-length:
+    max: 80
+  # GitHub Actions requires the key "on", which YAML 1.1 reads as a
+  # boolean; keys are exempt, values are still checked.
+  truthy:
+    check-keys: false

plexdo-2.0.3/AI.policy.txt

@@ -0,0 +1,6 @@
+
+AI has been trained almost exclusively on open source. Ethically, all rights, AI generated code should be automatically encumbered by the licenses of the code that generated it. While I can't make any corporation, AI platform, or government adopt such a policy, I can commit to a personal policy pertaining to what I generate with AI.
+
+All AI projects will be released GPL-3.
+All AI projects will be released with all available platform and prompt information to aid in reproducing, modifying, and collaborating development in the spirit of the open source community that started this in the first place.
+