umbraci.confluence-markdown-exporter 1.0.0__tar.gz

umbraci_confluence_markdown_exporter-1.0.0/.dockerignore

@@ -0,0 +1,18 @@
+.git
+.github
+.claude
+.venv
+dist
+build
+*.egg-info
+__pycache__
+.pytest_cache
+.ruff_cache
+.mypy_cache
+node_modules
+tests
+scratch
+.vscode
+.idea
+*.log
+.DS_Store

umbraci_confluence_markdown_exporter-1.0.0/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: Spenhouet

umbraci_confluence_markdown_exporter-1.0.0/.github/ISSUE_TEMPLATE/1_bug_report.yaml

@@ -0,0 +1,83 @@
+name: Bug report
+description: Report an error or unexpected behavior
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to report an issue! We're glad to have you involved with confluence-markdown-exporter.
+
+        **Before reporting, please make sure to search through [existing issues](https://github.com/Spenhouet/confluence-markdown-exporter/issues?q=is:issue+is:open+label:bug) (including [closed](https://github.com/Spenhouet/confluence-markdown-exporter/issues?q=is:issue%20state:closed%20label:bug)).**
+
+  - type: markdown
+    attributes:
+      value: |
+        ### Diagnostic info
+        Run `cme bugreport` and paste the full output in the **Diagnostic info** field below.
+        This command prints your version, system details, and configuration — with all secrets automatically redacted.
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: |
+        A clear and concise description of the bug, including a minimal reproducible example.
+
+        Be sure to include the command you invoked (e.g., `cme pages https://company.atlassian.net/wiki/spaces/KEY/pages/123/Title`).
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Diagnostic info
+      description: |
+        Paste the output of `cme bugreport` here.
+        This includes your version, Python/OS info, and configuration with secrets redacted.
+      placeholder: |
+        ## Bug Report Diagnostic Info
+
+        ### Version
+        confluence-markdown-exporter x.y.z
+
+        ### System
+        Python: ...
+        Platform: ...
+        Architecture: ...
+
+        ### Config
+        Config file: ...
+        ```yaml
+        ...
+        ```
+      render: markdown
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Version
+      description: |
+        What version of confluence-markdown-exporter are you using?
+        (Already included in `cme bugreport` output — fill in here only if you didn't run that command.)
+      placeholder: e.g., confluence-markdown-exporter 4.0.3
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Confluence Version
+      description: |
+        What Confluence version are you using? Include whether it's Cloud or Server/Data Center.
+        Example: `Confluence Cloud` or `Confluence Server 7.19.2`
+      placeholder: e.g., Confluence Cloud or Confluence Server 7.19.2
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Jira Version
+      description: |
+        What Jira version are you using (or not)? Include whether it's Cloud or Server/Data Center.
+        Example: `Jira Cloud` or `Jira Server 8.20.5`
+      placeholder: e.g., Jira Cloud or Jira Server 8.20.5
+    validations:
+      required: false

umbraci_confluence_markdown_exporter-1.0.0/.github/ISSUE_TEMPLATE/2_feature_request.yaml

@@ -0,0 +1,56 @@
+name: Feature request
+description: Suggest a new feature or enhancement
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to suggest a feature! We're glad to have you involved with confluence-markdown-exporter.
+
+        **Before submitting, please make sure to search through [existing feature requests](https://github.com/Spenhouet/confluence-markdown-exporter/issues?q=is:issue+is:open+label:enhancement) (including [closed](https://github.com/Spenhouet/confluence-markdown-exporter/issues?q=is:issue%20state:closed%20label:enhancement)).**
+
+  - type: textarea
+    attributes:
+      label: Problem Description
+      description: |
+        A clear and concise description of the problem or limitation you're experiencing.
+
+        What is the use case? What workflow or task would this feature enable or improve?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Proposed Solution
+      description: |
+        A clear and concise description of what you want to happen.
+
+        How do you envision this feature working? What would the ideal implementation look like?
+
+        If you have ideas about commands, options, or configuration, please include examples:
+        ```bash
+        # Example command or usage
+        confluence-markdown-exporter <your-suggested-command>
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternatives Considered
+      description: |
+        A clear and concise description of any alternative solutions or features you've considered.
+
+        Are there workarounds you're currently using? What other tools or approaches have you tried?
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Use Cases
+      description: |
+        Describe specific scenarios where this feature would be helpful.
+
+        Please provide concrete examples of how you (or others) would use this feature in practice.
+    validations:
+      required: false

umbraci_confluence_markdown_exporter-1.0.0/.github/ISSUE_TEMPLATE/3_question.yaml

@@ -0,0 +1,38 @@
+name: Question
+description: Ask a question about confluence-markdown-exporter
+labels: ["question"]
+body:
+  - type: textarea
+    attributes:
+      label: Question
+      description: Describe your question in detail.
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Version
+      description: What version of confluence-markdown-exporter are you using? (see `confluence-markdown-exporter version`)
+      placeholder: e.g., confluence-markdown-exporter 3.0.3
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Confluence Version
+      description: |
+        What Confluence version are you using? Include whether it's Cloud or Server/Data Center.
+        Example: `Confluence Cloud` or `Confluence Server 7.19.2`
+      placeholder: e.g., Confluence Cloud or Confluence Server 7.19.2
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Jira Version
+      description: |
+        What Jira version are you using (or not)? Include whether it's Cloud or Server/Data Center.
+        Example: `Jira Cloud` or `Jira Server 8.20.5`
+      placeholder: e.g., Jira Cloud or Jira Server 8.20.5
+    validations:
+      required: false

umbraci_confluence_markdown_exporter-1.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Documentation
+    url: https://github.com/Spenhouet/confluence-markdown-exporter#readme
+    about: Read the project documentation and README

umbraci_confluence_markdown_exporter-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+<!--
+Thank you for contributing to confluence-markdown-exporter! To help us out with reviewing, please consider the following:
+
+- Does this pull request include a summary of the change? (See below.)
+- Does this pull request include a descriptive title?
+- Does this pull request include references to any relevant issues?
+-->
+
+## Summary
+
+<!-- What's the purpose of the change? What does it do, and why? -->
+
+## Test Plan
+
+<!-- How was it tested? -->

umbraci_confluence_markdown_exporter-1.0.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    groups:
+      actions:
+        patterns:
+          - "*"

umbraci_confluence_markdown_exporter-1.0.0/.github/workflows/docker-build.yml

@@ -0,0 +1,51 @@
+name: Build Docker image
+
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - Dockerfile
+      - .dockerignore
+      - .github/workflows/docker-build.yml
+      - pyproject.toml
+      - uv.lock
+      - confluence_markdown_exporter/**
+  # Also build on push to main so the GHA cache is primed on the default
+  # branch. Tag-triggered publish runs fall back to the default branch's
+  # cache, which would otherwise stay cold until the first release.
+  push:
+    branches: [main]
+    paths:
+      - Dockerfile
+      - .dockerignore
+      - .github/workflows/docker-build.yml
+      - pyproject.toml
+      - uv.lock
+      - confluence_markdown_exporter/**
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build image (PR verification)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Build (no push)
+        uses: docker/build-push-action@v7
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: false
+          cache-from: type=gha
+          cache-to: type=gha,mode=max,ignore-error=true

umbraci_confluence_markdown_exporter-1.0.0/.github/workflows/docker-publish.yml

@@ -0,0 +1,86 @@
+name: Publish Docker image
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        description: "Release version to publish (e.g. 5.1.0)"
+        required: true
+        type: string
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Release version to publish (e.g. 5.1.0). Must match an existing git tag."
+        required: true
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Publish image to Docker Hub
+    runs-on: ubuntu-latest
+    environment:
+      name: dockerhub
+      url: https://hub.docker.com/r/${{ vars.DOCKERHUB_IMAGE || 'spenhouet/confluence-markdown-exporter' }}
+    env:
+      IMAGE_NAME: ${{ vars.DOCKERHUB_IMAGE || 'spenhouet/confluence-markdown-exporter' }}
+    steps:
+      - name: Checkout release tag
+        uses: actions/checkout@v7
+        with:
+          ref: ${{ inputs.version }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v6
+        with:
+          images: ${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{version}},value=${{ inputs.version }}
+            type=semver,pattern={{major}}.{{minor}},value=${{ inputs.version }}
+            type=semver,pattern={{major}},value=${{ inputs.version }}
+            type=raw,value=latest
+          labels: |
+            org.opencontainers.image.title=confluence-markdown-exporter
+            org.opencontainers.image.description=Export Confluence pages to Markdown
+            org.opencontainers.image.url=https://github.com/${{ github.repository }}
+            org.opencontainers.image.source=https://github.com/${{ github.repository }}
+            org.opencontainers.image.version=${{ inputs.version }}
+            org.opencontainers.image.licenses=MIT
+
+      - name: Build and push
+        uses: docker/build-push-action@v7
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max,ignore-error=true
+          provenance: true
+
+      - name: Update Docker Hub description
+        uses: peter-evans/dockerhub-description@v5
+        continue-on-error: true
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: ${{ env.IMAGE_NAME }}
+          short-description: Export Confluence pages to Markdown (CLI)
+          readme-filepath: ./README.md

umbraci_confluence_markdown_exporter-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,57 @@
+name: Deploy docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "overrides/**"
+      - "mkdocs.yml"
+      - "pyproject.toml"
+      - "uv.lock"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install docs dependencies
+        run: uv sync --locked --group docs
+
+      - name: Build site with Zensical
+        run: uv run zensical build --strict
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: site
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

umbraci_confluence_markdown_exporter-1.0.0/.github/workflows/publish-fork.yml

@@ -0,0 +1,50 @@
+name: Publish UmbraCi fork
+
+on:
+  push:
+    tags:
+      - 'umbraci-v*'
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    if: github.repository == 'UmbraCi/confluence-markdown-exporter'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/umbraci-confluence-markdown-exporter/
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Verify release branch and version
+        env:
+          RELEASE_TAG: ${{ github.ref_name }}
+        run: |
+          git merge-base --is-ancestor HEAD origin/heytea/export-wiki-upstream
+          python -c 'import os, re, tomllib; v = tomllib.load(open("pyproject.toml", "rb"))["project"]["version"]; assert re.fullmatch(r"(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)", v) and os.environ["RELEASE_TAG"] == "umbraci-v" + v, "Tag must match the project semantic version"'
+
+      - uses: astral-sh/setup-uv@v7
+
+      - name: Install dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Check and test
+        run: |
+          uv run ruff check
+          uv run pytest
+
+      - name: Build distributions
+        run: uv build --no-sources
+
+      - name: Verify built package
+        run: uv run --with dist/*.whl --no-project -- python -c "import confluence_markdown_exporter as c; assert c.__version__ != 'unknown', c.__version__"
+
+      - name: Publish to PyPI
+        run: uv publish

umbraci_confluence_markdown_exporter-1.0.0/.github/workflows/python-build.yml

@@ -0,0 +1,52 @@
+name: Build Python package
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test, lint and build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Run linting with ruff
+        run: uv run ruff check
+
+      - name: Run tests with pytest
+        run: uv run pytest
+
+      - name: Test build (with sources for development)
+        run: uv build
+
+      - name: Test build (without sources for publication)
+        run: |
+          rm -rf dist/
+          uv build --no-sources
+
+      - name: Test package installation and import
+        run: |
+          uv run --with dist/*.whl --no-project -- python -c "import confluence_markdown_exporter; print('Package imports successfully')"
+
+      - name: Test CLI commands
+        run: |
+          uv run --with dist/*.whl --no-project confluence-markdown-exporter --help
+          uv run --with dist/*.whl --no-project cme --help
+
+      - name: Upload build artifacts for inspection
+        uses: actions/upload-artifact@v7
+        with:
+          name: build-artifacts
+          path: dist/
+          retention-days: 5

umbraci_confluence_markdown_exporter-1.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,73 @@
+name: Publish Python package
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        description: "Release version to publish (e.g. 5.1.0)"
+        required: true
+        type: string
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Release version to publish (e.g. 5.1.0). Must match an existing git tag."
+        required: true
+        type: string
+
+permissions:
+  contents: write
+  id-token: write
+  attestations: write
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/p/confluence-markdown-exporter
+    steps:
+      - name: Checkout release tag
+        uses: actions/checkout@v7
+        with:
+          ref: ${{ inputs.version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Build distributions
+        run: uv build --no-sources
+
+      - name: Generate artifact attestations
+        uses: actions/attest-build-provenance@v4.2.2
+        with:
+          subject-path: "dist/*"
+
+      - name: Publish to PyPI
+        run: uv publish
+
+      - name: Sign the distributions with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v3.5.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+
+      # The release workflow leaves the release as a draft; publishing it here,
+      # after the assets are attached, is what makes it immutable.
+      - name: Upload signed artifacts and publish GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          VERSION="${{ inputs.version }}"
+          if [[ "$(gh release view "$VERSION" --repo "$GITHUB_REPOSITORY" --json isDraft -q .isDraft)" != "true" ]]; then
+            echo "Release $VERSION is already published; its assets are immutable. Skipping."
+            exit 0
+          fi
+          gh release upload "$VERSION" dist/** --repo "$GITHUB_REPOSITORY"
+          gh release edit "$VERSION" --draft=false --repo "$GITHUB_REPOSITORY"