Skip to content

Releases

v1.1.0

Choose a tag to compare

@github-actions github-actions released this 03 Nov 20:44
e68eab0

New features

  • Build caches and VCS metadata are never uploaded. The tarball now omits any path whose name is one of .doctrees, .buildinfo, .git, __pycache__, .pytest_cache, .ipynb_checkpoints, .DS_Store, Thumbs.db, .hg, or .svn, at any depth, and the step log reports how many entries were excluded. The list mirrors the Docverse Python client's EXCLUDED_PATH_NAMES (lsst-sqre/docverse#853). Docverse 1.0.0b14 and later also strip these on ingest; filtering in the action keeps the bytes from leaving the runner. A directory that contains nothing but excluded paths is refused as an empty upload.

Other changes

  • The Release workflow no longer runs scriv collect itself. Collecting the changelog entry into CHANGELOG.md is now a documented prerequisite of tagging a release, and the workflow fails if uncollected fragments remain in changelog.d/ or CHANGELOG.md has no non-empty section for the tagged version. The floating vX tag is only updated after these checks pass.

v1.0.0

Choose a tag to compare

@jonathansick jonathansick released this 20 Oct 18:24
00f2c88

New features

  • Initial release of lsst-sqre/docverse-upload, a native JavaScript (Node 24) GitHub Action that uploads a built documentation directory to Docverse. The action tars the directory, creates a build, uploads the tarball to the presigned URL, marks the build as uploaded, and then polls the build-processing job and each publish_edition job until the editions are live. Built against the Docverse 1.0.0b11 API; requires a Docverse server at 1.0.0b1 or later.
  • Builds are annotated with GitHub Actions provenance automatically. The build's git_ref defaults to $GITHUB_HEAD_REF on pull_request events and $GITHUB_REF_NAME otherwise, which is what Docverse uses to scope PR-preview editions.
  • Optionally posts (and updates in place) a pull request comment linking to the updated editions when a github-token with pull-requests: write is provided. On push events the comment goes to every open PR for the branch.
  • completed_with_errors is treated as success with a warning annotation per failed edition; publish failures and timeouts also warn rather than failing the step. Gate downstream steps on job-status and publish-status for strict behavior.
  • Inputs: org, project, dir, and token (required); base-url (default https://roundtable.lsst.cloud/docverse/api), git-ref, alternate-name, wait (default true), wait-for-publish (default true), wait-timeout (seconds, default 1800), github-token, and comment-on-pr (default true).
  • Outputs: build-id, build-url, published-url (the primary updated edition: the one tracking the build's git_ref, else main, else first by slug), job-status, publish-status (published, failed, timed-out, or skipped), and editions-json (array of slug, title, kind, published_url, publish_status).

What's Changed

  • DM-54686: Initial MVP of the docverse-upload action by @jonathansick in #1
  • DM-54687: Comment on PRs with edition preview URLs by @jonathansick in #5
  • Bump openapi-fetch from 0.13.8 to 0.17.0 by @dependabot[bot] in #4
  • Bump the dev-dependencies group across 1 directory with 4 updates by @dependabot[bot] in #2
  • Bump @actions/core from 1.11.1 to 3.0.1 by @dependabot[bot] in #3
  • Add dependabot-merge skill by @jonathansick in #6
  • DM-55159: Follow HATEOAS links instead of reconstructing API paths by @jonathansick in #12
  • Bump astral-sh/setup-uv from 8.1.0 to 8.2.0 in the actions group across 1 directory by @dependabot[bot] in #8
  • Add Dependabot auto-build + auto-merge pipeline by @jonathansick in #13
  • Bump the dev-dependencies group with 2 updates by @dependabot[bot] in #9
  • Bump tar from 7.5.15 to 7.5.16 by @dependabot[bot] in #10
  • Bump @actions/github from 6.0.1 to 9.1.1 by @dependabot[bot] in #11
  • Stop Dependabot helper workflows failing on non-bot pushes by @jonathansick in #14
  • Replace @vercel/ncc with esbuild for the bundler by @jonathansick in #16
  • Bump @types/node from 25.9.1 to 25.9.2 in the dev-dependencies group across 1 directory by @dependabot[bot] in #15
  • Bump actions/checkout from 6 to 7 by @dependabot[bot] in #18
  • DM-55493: Fix Dependabot auto-merge App token (client-id + Actions secret) by @jonathansick in #24
  • Bump astral-sh/setup-uv from 8.2.0 to 8.3.2 in the actions group across 1 directory by @dependabot[bot] in #23
  • Bump tar from 7.5.16 to 7.5.19 in the production-dependencies group across 1 directory by @dependabot[bot] in #21
  • Bump @types/node from 25.9.2 to 26.1.1 by @dependabot[bot] in #22
  • Bump the dev-dependencies group across 1 directory with 5 updates by @dependabot[bot] in #25
  • Bump tar from 7.5.19 to 7.5.20 in the production-dependencies group by @dependabot[bot] in #27
  • Bump actions/setup-node from 6 to 7 by @dependabot[bot] in #26
  • Bump the dev-dependencies group with 2 updates by @dependabot[bot] in #30
  • DM-55550: Adopt the org-scoped Docverse jobs API by @jonathansick in #31
  • Bump the dev-dependencies group with 2 updates by @dependabot[bot] in #33
  • Bump the dev-dependencies group with 2 updates by @dependabot[bot] in #35
  • DM-55688: Move dependabot to monthly grouped updates by @jonathansick in #36
  • Bump the dev-dependencies group with 2 updates by @dependabot[bot] in #37
  • Bump the dev-dependencies group with 4 updates by @dependabot[bot] in #39
  • Bump tar from 7.5.20 to 7.5.22 in the production-dependencies group across 1 directory by @dependabot[bot] in #34
  • Bump the dev-dependencies group with 3 updates by @dependabot[bot] in #41
  • Bump astral-sh/setup-uv from 8.3.2 to 10.2.0 by @dependabot[bot] in #40
  • Bump vitest from 4.1.11 to 5.0.3 by @dependabot[bot] in #42
  • DM-56095: Refresh Docverse API client for server 1.0.0b11 by @jonathansick in #43
  • DM-56095: Write the 1.0.0 changelog entry by @jonathansick in #44

New Contributors

Full Changelog: https://github.com/lsst-sqre/docverse-upload/commits/v1.0.0