Skip to content

docs: README for 6.0, releasing through JitPack, licence in the POM - #123

Merged
pashidlos merged 15 commits into
nextfrom
docs/readme-6.0
Nov 3, 2026
Merged

pashidlos merged 15 commits into
nextfrom
docs/readme-6.0

Conversation

@pashidlos

@pashidlos pashidlos commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

README for 6.0 and the licence in the POM. This is phase 2, part C.

Stacked on #122. Merge it after #122 (merge order #124 → #125 → #122 → this PR). The README describes Java 25 and the 6.0 install, so it ships with #122 as 6.0.0. It contains no code changes. It also notes that apiUrl trailing slashes are ignored (#124).

README

The README follows the template shared by the SDKs:

  • Install: Gradle and Maven via JitPack, plus an "Upgrading to 6.0" section.
  • Configuration:
    • one table of every option with its VRT_* variable;
    • builder, environment and vrt.json examples;
    • the precedence rule.
  • Usage, with the image table: Path, byte[] (multipart) and base64. Then TestRunOptions, including comment and merge.
  • Result and statuses: the six statuses plus UNKNOWN, and which of them throw.
  • Errors: TestRunException.getStatusCode(), what 413, 422 and 503 mean, and the retry policy.
  • Releasing: tag plus GitHub release; JitPack builds it. Includes the exact command JitPack runs, and why the artifact version is the tag.
  • Links and the licence.

Two things removed: the Codacy badge (phase 2 removes Codacy) and the old Java 11 requirement. The ${REPLACE_THIS_VALUE} placeholder from the audit was already gone on master.

Each claim was checked against the code and the 6.0 backend:

  • a repeated ciBuildId continues the build (upsert on projectId_ciBuildId);
  • merge only matters when the run is approved;
  • the JSON limit is 5 MB only in the shipped .env.

Licence

LICENSE is Apache-2.0, and GitHub detects it as Apache-2.0. The published POM now declares it too, with name and url. JitPack used to add this only from GitHub metadata.

🤖 Generated with Claude Code

@codecov-commenter

codecov-commenter commented Nov 2, 2026 •

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (next@d97c4f0). Learn more about missing BASE report.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             next     #123   +/-   ##
=======================================
  Coverage        ?   91.82%           
  Complexity      ?       68           
=======================================
  Files           ?        8           
  Lines           ?      269           
  Branches        ?       22           
=======================================
  Hits            ?      247           
  Misses          ?       18           
  Partials        ?        4           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

pashidlos and others added 7 commits November 2, 2026 23:30
- Gradle 6.1 -> 9.8.2 with a plugins {} block; freefair lombok 5.1.1 -> 9.8.3.
- Compile with release 17; CI runs on Java 17, 21 and 25; JitPack uses openjdk17.
- Drop the shadow plugin: nothing configured it and JitPack publishes the plain jar.
- Publish through maven-publish with a sources jar; group and version live in
  gradle.properties, so JitPack's -Pgroup/-Pversion from the tag override them.
- gson 2.15.0, slf4j 2.0.20; test deps to latest, mockwebserver3, hamcrest explicit,
  commons-io removed (unused), mockito attached as a javaagent.
- CI: checkout v7, setup-java v6, wrapper validation, codecov v7 over OIDC;
  the required `build` check aggregates the matrix and runs JitPack's commands.
- Dependabot weekly with minor-patch/major/security groups, plus github-actions.

BREAKING CHANGE: Java 17 or later is required.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…adle; lazy mockito agent

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… on cancelled runs, MIT cache provider

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README follows the template shared by the SDKs: install, configuration
(options table, environment variables, vrt.json), usage, result and statuses,
errors, releasing, links. The Codacy badge is removed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
pashidlos and others added 5 commits November 3, 2026 08:22
An apiUrl such as http://localhost:4200/ produced requests to //builds and
//test-runs. The URL is now stripped of trailing slashes whether it comes
from the constructor, the builder, VRT_APIURL or vrt.json, as sdk-python does.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…radle dependency graph

- logback-classic 1.5.16 -> 1.5.38 (CVE-2025-11226, CVE-2026-1225, CVE-2026-9828, CVE-2026-10532)
- mockwebserver 4.11.0 -> 4.12.0: okio 3.6.0 (CVE-2023-3635), junit 4.13.2 (CVE-2020-15250)
- drop the unused shadow 5.2.0 plugin and its log4j 2.11, ant 1.9.7, jdom2,
  plexus-utils and commons-io 2.6 build classpath; JitPack publishes the plain jar
- submit the Gradle dependency graph on pushes to master so Dependabot alerts
  see Gradle dependencies at all

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… 9 branch

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The minimum runtime is the latest LTS, Java 25 (release 25). CI builds on 25
and on 27, the newest non-LTS JDK, as a non-blocking forward-compatibility
check. JitPack and the dependency graph build on JDK 25.

BREAKING CHANGE: the SDK now requires Java 25 or later.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
pashidlos and others added 2 commits November 3, 2026 08:33
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Base automatically changed from build/gradle-9-java-17 to next November 3, 2026 07:08
@pashidlos
pashidlos changed the base branch from build/gradle-9-java-17 to next November 3, 2026 07:08
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@pashidlos
pashidlos merged commit 982296c into next Nov 3, 2026
3 checks passed
@pashidlos
pashidlos deleted the docs/readme-6.0 branch November 3, 2026 07:10
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