Skip to content

docs: add versioned Android API documentation - #158

Open
crandmck wants to merge 2 commits into
mainfrom
docs-versioned-api-docs
Open

crandmck wants to merge 2 commits into
mainfrom
docs-versioned-api-docs

Conversation

@crandmck

@crandmck crandmck commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator

Changes in this pull request

Add release-based Dokka API documentation versioning, following the other C2PA SDK documentation sites.

Update: Replaced Python tooling with Bash plus jq, and updated Make, CI, and prerequisites.

  • Build 0.0.15 (default) and 0.0.14 from their published GitHub release tags, selected in docs/versions.json.
  • Keep the existing site and direct package URLs serving the default release; publish each selected release under /c2pa-android/versions/<tag>/.
  • Add an accessible version selector in the existing Dokka header, with desktop/mobile layout and theme controls preserved.
  • Add isolated release builds, validated tag/archive paths, GitHub-token removal from Gradle, and preservation of existing output if a release build fails.
  • Add PR build checks and explicit post-release Pages deployment, with read-only build permissions and deployment-only Pages/OIDC permissions.
  • Document make docs-versioned, make docs-test, and version maintenance; preserve make docs and its separate working-tree output.

Types of changes

  • Bug fix
  • New feature (non-breaking)
  • Breaking change

Validation

  • Passed: 12 Bash tests and 7 JavaScript tests
  • Passed: actual Dokka builds for both selected releases using a temporary Java 17 and Android SDK/NDK toolchain.
  • Passed: all 3,117 generated HTML files and 85,305 internal page/resource links checked.
  • Passed: browser checks for existing URLs, deep API pages and visible declarations, version switching, desktop/mobile non-overlap, and working native theme controls.
  • Passed: workflow YAML/permission checks, JavaScript syntax, and whitespace checks.

Dokka reports existing Android-extension and external-type link-resolution warnings. The same warnings reproduce in the unchanged working-tree documentation build; neither release build fails. Temporary validation resources were removed.

Checklist

  • All applicable changes have been documented.
  • No new TODO items introduced.

Build selected published releases with Dokka, add a header version selector, and deploy default and version-specific API documentation through GitHub Pages.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@crandmck
crandmck requested review from n8fr8 and redaranj October 19, 2026 20:33
@codecov

codecov Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.93%. Comparing base (c8a8431) to head (b8d19e2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #158   +/-   ##
=========================================
  Coverage     71.93%   71.93%           
  Complexity       36       36           
=========================================
  Files            62       62           
  Lines          2362     2362           
  Branches        293      293           
=========================================
  Hits           1699     1699           
  Misses          495      495           
  Partials        168      168           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant