Skip to content

Docs: use rolling Java snapshot coordinates - #248

Closed
edburns wants to merge 4 commits into
github:mainfrom
edburns:edburns/car-32910-rolling-snapshot-docs
Closed

edburns wants to merge 4 commits into
github:mainfrom
edburns:edburns/car-32910-rolling-snapshot-docs

Conversation

@edburns

@edburns edburns commented Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

Superseded by #249 .

Problem

Versioned preview documentation currently uses the shared SDK prerelease as the Maven, Gradle, and JBang coordinate. Java previews now use one rolling Maven snapshot per base version, so those examples would point to an unpublished coordinate.

Changes

  • Add a separate optional artifact_version workflow input while preserving version for site directories and release/source identity.
  • Render Maven, Gradle, JBang, and cookbook coordinates from the artifact version.
  • Add Central snapshot repository configuration only for snapshot artifacts.
  • Reject preview deployments that omit the artifact version so the runtime dispatcher and site contract roll out in order.

Validation

  • node --test scripts/prepare-site-versions.test.mjs — passed (3 tests).
  • mvn site -Dsite.version=1.0.15-preview.2 -Dartifact.version=1.0.15-SNAPSHOT ... — BUILD SUCCESS; rendered site kept 1.0.15-preview.2 metadata and used 1.0.15-SNAPSHOT plus snapshot repositories.
  • mvn site -Dsite.version=1.0.15 -Dartifact.version=1.0.15 ... — BUILD SUCCESS; rendered stable coordinates remained 1.0.15 with no snapshot repository.

Rollout dependency

Merge this pull request before github/copilot-agent-runtime#33343 begins sending artifact_version. The runtime pull request remains draft until this receiving workflow is available.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 8a93f06c-3318-405d-ad86-fcf729e58207
Copilot AI auto review requested due to automatic review settings November 3, 2026 19:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The deployment workflow directly interpolates artifact_version into shell source, enabling command execution with repository and Pages write permissions before validation.

3 open issues
What changed in this PR

Separates Java dependency coordinates from documentation versions so preview sites can reference rolling Maven snapshots while preserving release-specific site identity.

Changes:

  • Adds an optional artifact_version deployment input and Maven property.
  • Prepares dependency examples and conditionally adds snapshot repository instructions.
  • Adds rendering tests and a guard intended to require artifact versions for preview deployments.
File Description
src/​site/​markdown/​index.md Uses artifact coordinates and repository placeholders in installation examples.
src/​site/​markdown/​getting-started.md Updates setup examples for rolling snapshot artifacts.
scripts/​prepare-site-versions.test.mjs Tests preview and stable preparation plus base-version validation.
scripts/​prepare-site-versions.mjs Validates versions, rewrites coordinates, and renders repository instructions.
pom.xml Defines an independently overridable artifact version.
.github/​workflows/​deploy-site.yml Accepts the artifact version and passes it through site preparation and rendering.

Review effort: Balanced (auto)

Comment thread .github/workflows/deploy-site.yml Resolved
Comment thread .github/workflows/deploy-site.yml Resolved
Comment thread scripts/prepare-site-versions.mjs Resolved
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 8a93f06c-3318-405d-ad86-fcf729e58207
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 8a93f06c-3318-405d-ad86-fcf729e58207
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 8a93f06c-3318-405d-ad86-fcf729e58207
@edburns edburns closed this Nov 4, 2026
@edburns edburns reopened this Nov 4, 2026
@edburns edburns closed this Nov 4, 2026
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.

2 participants