Repository navigation
Docs: use rolling Java snapshot coordinates - #249
Merged
Merged
Conversation
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
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 8a93f06c-3318-405d-ad86-fcf729e58207
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues were identified for the changes separating documentation versions from Maven artifact coordinates.
No open issues 🎉
What changed in this PR
Separates documentation version identity from Java artifact coordinates so preview sites can reference rolling Maven snapshots while retaining version-specific URLs and source identity.
Changes:
- Adds an optional
artifact_versionworkflow input, required for preview deployments. - Uses artifact versions in dependency examples and adds snapshot repositories only for snapshot artifacts.
- Adds validation and tests for version compatibility, coordinate rendering, and workflow input handling.
| File | Description |
|---|---|
src/site/markdown/index.md |
Uses artifact-version placeholders and repository markers; explains rolling snapshots. |
src/site/markdown/getting-started.md |
Updates installation examples for separate artifact versions and snapshot repositories. |
scripts/prepare-site-versions.test.mjs |
Tests preview and stable rendering, version validation, and workflow wiring. |
scripts/prepare-site-versions.mjs |
Validates versions, rewrites coordinates, and inserts snapshot repository instructions. |
pom.xml |
Defines artifact.version, defaulting to site.version. |
.github/workflows/deploy-site.yml |
Accepts and validates the artifact input, prepares examples, and passes it to Maven. |
Review effort: Balanced (auto)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
artifact_versionworkflow input while preservingversionfor site directories and release/source identity.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 kept1.0.15-preview.2metadata and used1.0.15-SNAPSHOTplus snapshot repositories.mvn site -Dsite.version=1.0.15 -Dartifact.version=1.0.15 ...— BUILD SUCCESS; rendered stable coordinates remained1.0.15with 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.