Skip to content

docs(sdk): correct the Java release guide's missing-secret behaviour - #1086

Merged
rmyndharis merged 1 commit into
mainfrom
docs/java-sdk-release-guard-is-a-hard-failure
Aug 6, 2026
Merged

docs(sdk): correct the Java release guide's missing-secret behaviour#1086
rmyndharis merged 1 commit into
mainfrom
docs/java-sdk-release-guard-is-a-hard-failure

Conversation

@rmyndharis

Copy link
Copy Markdown
Owner

sdk/java/README.md -> Releasing promised that until the publish secrets exist the workflow "cleanly no-ops (it prints a notice and skips the deploy), so tagging early is harmless".

The workflow does the opposite, and deliberately so. The credential guard (java-sdk-release.yml) collects every missing secret and exits 1, with its own comment explaining why: a skipped deploy that reports green is indistinguishable from a real release in the run list.

Someone following the README would tag a release expecting a harmless run and get a red one instead — or, worse, trust the inverse promise while auditing why a release did not appear.

Noticed while auditing which SDKs actually publish automatically; unrelated to that work, so it is its own change.

Not reformatted: the file is not Prettier-clean on main and markdown is not gated by CI, so running the formatter here would bury a two-line correction in unrelated churn.

The Releasing section promised that until the publish secrets exist the
workflow "cleanly no-ops (it prints a notice and skips the deploy), so tagging
early is harmless". The workflow does the opposite and has for a while: the
credential guard collects every missing secret and exits 1, precisely because a
skipped deploy reporting green is indistinguishable from a real release in the
run list.

Left as-is: this file is not Prettier-clean on main and markdown is not gated by
CI, so reformatting it here would bury a two-line correction in noise.
@rmyndharis
rmyndharis force-pushed the docs/java-sdk-release-guard-is-a-hard-failure branch from 6e83871 to ac12e90 Compare August 6, 2026 03:15
@rmyndharis
rmyndharis merged commit e3f837b into main Aug 6, 2026
13 checks passed
@rmyndharis
rmyndharis deleted the docs/java-sdk-release-guard-is-a-hard-failure branch August 6, 2026 03:15
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.

1 participant