Repository navigation
Conversation
Collaborator
Author
|
@ulysses4ever Hi, what do you think of this version of the check API? |
Collaborator
|
This looks good. Im happy to approve after you strike the test changes (apiCheck). Maybe take a screenshot for other reviewers . Two things I can suggest:
|
zlonast
force-pushed
the
zlonast/check-api
branch
from
September 19, 2026 00:53
461d580 to
36fc9a5
Compare
ffaf1
reviewed
Oct 7, 2026
Comment on lines
+95
to
+96
| if [ -z "$base" ] || [ "$base" = "0000000000000000000000000000000000000000" ]; then | ||
| base="$(git merge-base origin/master HEAD)" |
ffaf1
reviewed
Oct 7, 2026
Comment on lines
+184
to
+205
| does not block merging, it exists to inform you and the reviewers: | ||
|
|
||
| - whether a PR changes the public API (perhaps accidentally); | ||
| - what to write in the changelog entry and which version bump PVP requires; | ||
| - whether the PR is a candidate for backporting to a release branch | ||
| (API-changing PRs usually are not). | ||
|
|
||
| The diff is computed in CI with a single pinned GHC and no golden files are | ||
| committed, so there is nothing to update when the API changes. When the API | ||
| changed, the job checks that the PR documents the change: at least one | ||
| changelog file under `changelog.d/` must list the package in its `packages:` | ||
| field, otherwise the job fails. The job also warns when such an entry does not | ||
| mention any of the changed modules or declarations. This is the | ||
| machine-checked version of the PR template checkbox: *either the `Check API` | ||
| job is clean, or the API changes are documented in a changelog file*. | ||
|
|
||
| To run the same diff locally: | ||
|
|
||
| ```console | ||
| $ make api-install # once; installs packdiff from the pinned commit | ||
| $ make api-diff # all four packages, against origin/master | ||
| $ make api-diff PKG=Cabal-syntax API_BASE=3.14 # one package, against a branch/tag |
Collaborator
There was a problem hiding this comment.
This is too verbose imho, one paragaph (the first), slightly reworded will do.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an informational "Check API" job that shows, on every pull request, how the
public API of
Cabal-syntax,Cabal,cabal-install-solverandCabal-hookschanges with respect to the PR base.
The job is not a required check and does not block merging; it exists to:
a backport candidate").
Template B: This PR does not modify behaviour or interface
E.g. the PR only touches documentation or tests, does refactorings, etc.
Include the following checklist in your PR:
Check APIjob is clean, or the API changes are documented in a changelog file.