Skip to content

core: enforce exact public API signatures #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pzhin merged 1 commit into from
Aug 22, 2026
Merged

core: enforce exact public API signatures #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions docs/TOOLING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,26 @@ This command blocks on:
- at least 80% line coverage for all `sfqd-core` production classes;
- SpotBugs at maximum effort with zero allowed findings;
- JavaDoc errors or warnings;
- exact binary/source/JavaDoc artifact contents and public API surface.
- exact binary/source/JavaDoc artifact contents;
- the checked-in public API signature manifest, including public types, public/protected members,
generic signatures, modifiers, record components, and sealed permitted subclasses.

The Java artifact verifier also inserts the project license into the source and
JavaDoc JARs without invoking platform-specific archive tools.
JavaDoc JARs without invoking platform-specific archive tools. Both the unit
gate and artifact verifier compare compiled output with
`sfqd-core/src/main/api/public-api.txt`; adding a documented public member to an
existing type therefore fails the build. Before the first release, regenerate
the candidate manifest after compilation with:

```shell
java -cp sfqd-core/target/test-classes:sfqd-core/target/classes \
io.github.pzhin.sfqd.build.PublicApiManifest sfqd-core/target/classes
```

Review and commit the output only for an intentional API change. After `0.1.0`,
artifact-to-artifact compatibility checking with Revapi or japicmp should use
the previous published release as its baseline; the manifest remains the
fail-closed exact-surface gate for the current release line.

`tools/verify-javadoc-gate.sh` adds an undocumented public class, constructor,
and method in a detached worktree. The build must fail at the JavaDoc goal. A
Expand Down
Loading