Docs: Document nightly snapshots#16544
Open
wombatu-kun wants to merge 1 commit into
Open
Conversation
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Closes #15191
Summary
Apache Iceberg publishes a nightly snapshot of every module to the Apache snapshot repository (via the
publish-snapshotworkflow, daily at 00:00 UTC), but until now this was only mentioned in a single sentence inmulti-engine-support.mdwith no usage examples. This PR adds a dedicated, developer-only page documenting how to consume those snapshots, addressing #15191.Per the ASF release policy on publication — and the point raised in the issue discussion — the page leads with a prominent warning that snapshots are unreleased, must not be used in production, and are intended only for active Iceberg developers, directing everyone else to official releases.
What changed
site/docs/nightly-snapshots.md: a "developers only" warning admonition, an explanation of the daily snapshot and its version, and copy-pasteable Gradle, Maven, sbt, and Spark examples that add the snapshot repository and depend on the snapshot version.site/mkdocs.yml: a newsnapshotVersionmacro (1.12.0-SNAPSHOT) so the version in the examples stays current the same wayicebergVersiondoes; the Spark example also reuses the existingsparkVersionMajormacro.site/nav.yml: adds the page under the developer-facing "Project" section (not top-level "Releases"), reinforcing that snapshots are for developers.site/docs/multi-engine-support.md: re-points the existing one-line snapshot mention to the new page instead of duplicating it.site/docs/how-to-release.md: notes that the "Site update" release step should also bumpsnapshotVersion, so the macro does not go stale.