You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 9c15610
Browse filesBrowse the repository at this point in the historyBrowse files
Fail the API check when its options narrow it outside an X.0.0 version
An empty comparison, <includes>, <overrideCompatibilityChangeParameters>, a public-only <accessModifier> or <includeSynthetic>false hid a break the same way <excludes> did. The message now covers excludes left over from a major that just shipped.
Copy file name to clipboardExpand all lines: AGENTS.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,9 @@ Bugfixes and small features stop at this skill.
47
47
## Releases
48
48
49
49
Follow the [Releasing a version](https://github.com/graphql-java-kickstart/graphql-java-tools/wiki/Releasing-a-version) wiki
50
-
page. `github-build.sh` and `.github/workflows/release.yml` do the version bump, tag and publish.
50
+
page. `github-build.sh` and `.github/workflows/release.yml` do the version bump, tag and publish. After an X.0.0 release,
51
+
delete the `<excludes>` under japicmp-maven-plugin in `pom.xml`. The version is X.0.1-SNAPSHOT by then and the API check
52
+
fails while they remain.
51
53
52
54
## Rules that need judgment
53
55
@@ -86,7 +88,7 @@ happening. "docs only" means nothing does yet, so the rule depends on you readin
86
88
| Argument conversion goes through one entry point | docs only |
87
89
| An input field's Java type comes from the mapping Jackson uses, not from guessed getters | docs only |
88
90
| Every recursive walk over the type graph handles cycles, and a test covers a cycle | docs only |
89
-
| Public signatures stay binary compatible, data class `copy()` and `componentN` included | japicmp with `build/japicmp-kotlin-public.groovy` at `mvn verify`, excludes only at an X.0.0 version |
91
+
| Public signatures stay binary compatible, data class `copy()` and `componentN` included | japicmp with `build/japicmp-kotlin-public.groovy` at `mvn verify`, which allows excludes and other narrowing options only at an X.0.0 version |
90
92
| Remove the plumbing a change leaves unused | Compiler warnings for unused locals, docs only for the rest |
91
93
| A new warning or build error names the type and the item and uses `SourceLocation.describe()` for its location | docs only |
92
94
| A check keyed on a class name or an exception type has a test that fails when the dependency moves it | docs only |
0 commit comments