Documenting snapshot builds - #1977
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds user-facing documentation for consuming snapshot (main-branch) builds of the OpenTelemetry Android artifacts, and adjusts release automation to keep README version references up to date.
Merge Tier: 3 (build/release automation changes)
Changes:
- Document how to add Sonatype’s snapshot repository and depend on
*-SNAPSHOTBOM versions in Gradle. - Update the release-branch preparation workflow’s README version rewrite to avoid matching the new snapshot example.
- Extend the version update script to also bump the README’s snapshot BOM version when versions are advanced.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a new “Snapshot Builds” section with Gradle configuration and BOM usage example. |
| .github/workflows/prepare-release-branch.yml | Narrows the README BOM version rewrite pattern so it won’t affect -SNAPSHOT lines. |
| .github/scripts/update-version.sh | Updates the README snapshot BOM version alongside gradle.properties version bumps. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1977 +/- ##
=======================================
Coverage 65.67% 65.67%
=======================================
Files 172 172
Lines 3918 3918
Branches 442 442
=======================================
Hits 2573 2573
Misses 1213 1213
Partials 132 132 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Explaining users how to use snapshot versions in their projects