Skip to content

Fix stale snapshot version in README and automate updates#62

Open
brunoborges wants to merge 1 commit intomainfrom
fix-snapshot-version-in-readme
Open

Fix stale snapshot version in README and automate updates#62
brunoborges wants to merge 1 commit intomainfrom
fix-snapshot-version-in-readme

Conversation

@brunoborges
Copy link
Copy Markdown
Collaborator

Problem

The snapshot version in README.md was stuck at 0.2.1-java.0-SNAPSHOT while the current pom.xml is at 0.2.3-java.1-SNAPSHOT. The release workflow's sed patterns only matched non-SNAPSHOT <version> tags, so the snapshot line was never updated during releases.

Changes

  • README.md: Fix snapshot version from 0.2.1-java.0-SNAPSHOT0.2.3-java.1-SNAPSHOT
  • publish-maven.yml: Add a sed command to update the -SNAPSHOT version in README during releases using DEV_VERSION from the versions step, preventing this from going stale again

Update the snapshot version in README.md from 0.2.1-java.0-SNAPSHOT to
0.2.3-java.1-SNAPSHOT to match the current pom.xml. Add a sed command
to the publish-maven workflow to update the snapshot version during
releases, preventing it from going stale again.

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

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the README snapshot dependency version to match the current pom.xml development version, and adjusts the Maven publish workflow so future releases also update the README’s -SNAPSHOT version automatically.

Changes:

  • Update README.md snapshot dependency version to 0.2.3-java.1-SNAPSHOT.
  • Extend publish-maven.yml to update the README snapshot <version>...-SNAPSHOT</version> using steps.versions.outputs.dev_version during releases.
Show a summary per file
File Description
README.md Fixes stale snapshot dependency version to match the current development version.
.github/workflows/publish-maven.yml Automates updating the README snapshot version during the release workflow to prevent staleness.

Copilot's findings

  • Files reviewed: 2/2 changed files
  • Comments generated: 0

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