docs: update README dependency examples to 3.0.1 - #294
Conversation
📝 WalkthroughWalkthroughDocumentation in ChangesLibrary Version Documentation Update
Estimated code review effort🎯 2 (Simple) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@readme.md`:
- Line 30: The README claims the library version is "3.0.1" but that version is
not published to Maven Central for artifacts
logstash-logging-spring-boot-starter, loki-logging-spring-boot-starter, and
reactive-logstash-logging-spring-boot-starter; revert the README change so it
does not reference "3.0.1" (use the last known published version or remove the
version line) and add a short TODO/note to update to "3.0.1" after the artifacts
are actually released to Maven Central.
- Around line 67-69: The manual install docs have a filename mismatch: update
the pomFile setting that currently references
"reactive-logstash-logging-spring-boot-starter-3.0.1.RELEASE.pom" (used by the
maven-install-plugin) to match the intended file name
"reactive-logstash-logging-spring-boot-starter-3.0.1.pom" so the plugin can find
the file; ensure the README's instructions and the pomFile value are consistent
with the jar name "3.0.1.jar".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| ## Getting started | ||
| The current version of library is `2.2.1`.\ | ||
| The current version of library is `3.0.1`.\ |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify all three artifacts are published to Maven Central at version 3.0.1
# Check logstash-logging-spring-boot-starter
echo "Checking logstash-logging-spring-boot-starter..."
curl -s "https://search.maven.org/solrsearch/select?q=g:com.github.piomin+AND+a:logstash-logging-spring-boot-starter+AND+v:3.0.1" | jq '.response.numFound'
# Check loki-logging-spring-boot-starter
echo "Checking loki-logging-spring-boot-starter..."
curl -s "https://search.maven.org/solrsearch/select?q=g:com.github.piomin+AND+a:loki-logging-spring-boot-starter+AND+v:3.0.1" | jq '.response.numFound'
# Check reactive-logstash-logging-spring-boot-starter
echo "Checking reactive-logstash-logging-spring-boot-starter..."
curl -s "https://search.maven.org/solrsearch/select?q=g:com.github.piomin+AND+a:reactive-logstash-logging-spring-boot-starter+AND+v:3.0.1" | jq '.response.numFound'
# Expected: Each should return 1 if the version existsRepository: piomin/spring-boot-logging
Length of output: 228
Version 3.0.1 does not exist on Maven Central. All three artifacts (logstash-logging-spring-boot-starter, loki-logging-spring-boot-starter, reactive-logstash-logging-spring-boot-starter) with group ID com.github.piomin returned zero results for version 3.0.1 in Maven Central. This contradicts the PR objectives claiming the release is already published. Do not merge documentation references to a non-existent version, or defer the documentation update until after the actual release to Maven Central.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@readme.md` at line 30, The README claims the library version is "3.0.1" but
that version is not published to Maven Central for artifacts
logstash-logging-spring-boot-starter, loki-logging-spring-boot-starter, and
reactive-logstash-logging-spring-boot-starter; revert the README change so it
does not reference "3.0.1" (use the last known published version or remove the
version line) and add a short TODO/note to update to "3.0.1" after the artifacts
are actually released to Maven Central.
| Add `reactive-logstash-logging-spring-boot-starter-3.0.1.pom` to `${basedir}/dependencies` | ||
|
|
||
| Add `pom.xml` to `${basedir}/dependencies` and rename to `reactive-logstash-logging-spring-boot-starter-2.2.1.pom` | ||
| Add `pom.xml` to `${basedir}/dependencies` and rename to `reactive-logstash-logging-spring-boot-starter-3.0.1.pom` |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify the correct POM filename pattern for this project
# Check if there are any published POM files in the repository
fd -e pom -e xml . --max-depth 3
# Search for any references to .RELEASE in existing POM files or documentation
rg -i "\.RELEASE\.pom" --type md --type xmlRepository: piomin/spring-boot-logging
Length of output: 473
🏁 Script executed:
cat -n reactive-logstash-logging-spring-boot-starter/pom.xml | head -50Repository: piomin/spring-boot-logging
Length of output: 2224
🏁 Script executed:
rg "RELEASE" --type xml --type md -B2 -A2Repository: piomin/spring-boot-logging
Length of output: 405
Filename inconsistency in manual installation instructions.
Lines 67 and 69 instruct users to add and rename the file to reactive-logstash-logging-spring-boot-starter-3.0.1.pom, but line 85's pomFile configuration references reactive-logstash-logging-spring-boot-starter-3.0.1.RELEASE.pom (with .RELEASE suffix). This mismatch will cause the maven-install-plugin to fail because it cannot find the file at the specified path. The .jar file reference on line 83 uses 3.0.1.jar without the .RELEASE suffix, confirming the correct naming pattern.
Remove the .RELEASE suffix from line 85:
- <pomFile>${basedir}/dependencies/reactive-logstash-logging-spring-boot-starter-3.0.1.RELEASE.pom</pomFile>
+ <pomFile>${basedir}/dependencies/reactive-logstash-logging-spring-boot-starter-3.0.1.pom</pomFile>🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@readme.md` around lines 67 - 69, The manual install docs have a filename
mismatch: update the pomFile setting that currently references
"reactive-logstash-logging-spring-boot-starter-3.0.1.RELEASE.pom" (used by the
maven-install-plugin) to match the intended file name
"reactive-logstash-logging-spring-boot-starter-3.0.1.pom" so the plugin can find
the file; ensure the README's instructions and the pomFile value are consistent
with the jar name "3.0.1.jar".
1 participant
Summary
This updates the README to use the current project version,
3.0.1, in the getting-started dependency snippets and manual installation examples.Why
The repository release and parent POM are already on
3.0.1, while the README still references2.2.1, which may confuse users copying the setup instructions.Summary by CodeRabbit