debugbrief 1.3.0__tar.gz → 1.4.0__tar.gz

debugbrief-1.4.0/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Code owners for DebugBrief.
+# The owner is requested for review on pull requests that touch matching paths.
+# A catch-all keeps the whole repository owned while there is a single maintainer.
+
+* @hari-kancharla

debugbrief-1.4.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,41 @@
+name: Bug report
+description: Report something that does not work as documented.
+labels: ["bug"]
+body:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened
+      description: What you did, what you expected, and what occurred instead.
+      placeholder: |
+        Steps:
+        1. debugbrief run -- ...
+        2. ...
+
+        Expected: ...
+        Actual: ...
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: DebugBrief version
+      description: Output of `debugbrief --version`.
+      placeholder: debugbrief 1.3.0
+    validations:
+      required: true
+  - type: input
+    id: environment
+    attributes:
+      label: OS and Python version
+      placeholder: macOS 14, Python 3.12
+    validations:
+      required: true
+  - type: textarea
+    id: output
+    attributes:
+      label: Relevant output
+      description: Command output or a report excerpt. Remove anything sensitive.
+      render: text
+    validations:
+      required: false

debugbrief-1.4.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,25 @@
+name: Feature request
+description: Suggest a change or addition.
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What are you trying to do that DebugBrief does not support today?
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed change
+      description: What you would like it to do, and how you imagine using it.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Workarounds you have tried or other approaches you weighed.
+    validations:
+      required: false

debugbrief-1.4.0/.github/workflows/ci.yml

@@ -0,0 +1,122 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install dev dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+      - name: Ruff
+        run: python -m ruff check src tests
+      - name: mypy
+        run: python -m mypy src/debugbrief
+
+  test:
+    # Unix-only by design. DebugBrief does not support Windows/PowerShell,
+    # so CI runs on Linux and macOS only and never on a Windows runner.
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install with dev dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Run tests
+        run: python -m pytest -q
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Install the built wheel into a clean environment
+        shell: bash
+        run: |
+          set -euo pipefail
+          python -m venv /tmp/wheelenv
+          /tmp/wheelenv/bin/python -m pip install --upgrade pip
+          /tmp/wheelenv/bin/python -m pip install dist/*.whl
+          /tmp/wheelenv/bin/python -m pip check
+
+      - name: Versions agree (package, metadata, pyproject)
+        shell: bash
+        run: |
+          set -euo pipefail
+          py=/tmp/wheelenv/bin/python
+          pkg=$("$py" -c "import debugbrief; print(debugbrief.__version__)")
+          meta=$("$py" -c "from importlib.metadata import version; print(version('debugbrief'))")
+          proj=$(grep -m1 -E '^version = ' pyproject.toml | sed -E 's/.*"([^"]+)".*/\1/')
+          echo "package=$pkg metadata=$meta pyproject=$proj"
+          test "$pkg" = "$meta"
+          test "$pkg" = "$proj"
+
+      - name: CLI smoke checks from the installed wheel
+        shell: bash
+        run: |
+          set -euo pipefail
+          db=/tmp/wheelenv/bin/debugbrief
+          tmp="$(mktemp -d)"
+          cd "$tmp"
+          git init -q
+          git config user.email "ci@example.com"
+          git config user.name "CI"
+          git checkout -q -b main
+          echo "seed" > seed.txt
+          git add seed.txt
+          git commit -qm "init"
+
+          "$db" --version
+          "$db" --help
+
+          # doctor: warnings (exit 1) are acceptable in a fresh repo;
+          # only blocking issues (exit 2) should fail the smoke check.
+          rc=0
+          "$db" doctor || rc=$?
+          if [ "$rc" -gt 1 ]; then
+            echo "doctor reported blocking issues (exit $rc)"
+            exit 1
+          fi
+
+          "$db" start "ci smoke"
+          "$db" note ci note without quotes
+          "$db" run -- python -c "print('ok')"
+          "$db" run -- python -c "import sys; sys.exit(1)" || true
+          "$db" redo || true
+          "$db" preview > /dev/null
+          "$db" end
+          "$db" last
+          "$db" list
+
+          # A broken downstream pipe must stop the command promptly, not hang to
+          # the timeout.
+          "$db" start "pipe smoke"
+          start=$(date +%s)
+          "$db" run --timeout 30 -- yes | head -n 1 > /dev/null || true
+          elapsed=$(( $(date +%s) - start ))
+          if [ "$elapsed" -gt 10 ]; then
+            echo "broken-pipe run did not stop promptly (${elapsed}s)"
+            exit 1
+          fi
+          "$db" cancel --yes

debugbrief-1.4.0/.github/workflows/pages.yml

@@ -0,0 +1,46 @@
+name: Deploy website (manual)
+
+# Local work does not deploy. Once reviewed and pushed, an authorized maintainer
+# must explicitly run this workflow on main. Pull requests cannot deploy.
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: github-pages
+  cancel-in-progress: false
+
+jobs:
+  validate:
+    if: github.ref == 'refs/heads/main' && github.repository == 'hari-kancharla/Debug-Brief'
+    uses: ./.github/workflows/site.yml
+
+  build:
+    needs: validate
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: read
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/configure-pages@v5
+      - name: Package static website
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy reviewed website artifact
+        id: deployment
+        uses: actions/deploy-pages@v5

debugbrief-1.4.0/.github/workflows/release.yml

@@ -0,0 +1,65 @@
+name: Release
+
+# Builds the tagged source and publishes through the existing PyPI project's
+# GitHub Trusted Publisher for this repository, release.yml and environment pypi.
+# No long-lived publishing token is stored in the repository.
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Verify the release tag matches the package version
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          project_version=$(python -c '
+          import tomllib
+          with open("pyproject.toml", "rb") as f:
+              print(tomllib.load(f)["project"]["version"])
+          ')
+          if [ "$tag" != "$project_version" ]; then
+            echo "Release tag '$tag' does not match pyproject version '$project_version'." >&2
+            echo "Update the version in pyproject.toml or retag the release, then try again." >&2
+            exit 1
+          fi
+          echo "Release tag matches package version: $project_version"
+      - name: Install build tooling
+        run: python -m pip install --upgrade pip build twine
+      - name: Build wheel and sdist
+        run: python -m build
+      - name: Check distributions
+        run: twine check dist/*
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/project/debugbrief/
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

debugbrief-1.4.0/.github/workflows/site.yml

@@ -0,0 +1,45 @@
+name: Website checks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  website:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+      - uses: actions/setup-node@v6
+        with:
+          node-version: '22'
+          cache: npm
+      - name: Install verification tools
+        run: |
+          python -m pip install -e '.[dev]'
+          npm ci
+          npx playwright install --with-deps chromium
+      - name: Verify site links and generated fixtures
+        run: |
+          python scripts/check_site.py
+          python scripts/generate_samples.py --check
+          python -m pytest -q tests/test_site.py
+      - name: Test browser interactions, imports, accessibility and reflow
+        run: npm run test:site
+      - name: Retain browser evidence
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: website-verification
+          path: |
+            artifacts/verification/
+            test-results/
+          retention-days: 7