-
Notifications
You must be signed in to change notification settings - Fork 697
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cabal-syntax and Cabal only; I assume cabal-install-solver is not a public API.
- Loading branch information
Showing
3 changed files
with
19,809 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
name: Check API | ||
|
||
on: | ||
push: | ||
paths-ignore: | ||
- "doc/**" | ||
- "**/README.md" | ||
- "CONTRIBUTING.md" | ||
branches: | ||
- master | ||
pull_request: | ||
paths-ignore: | ||
- "doc/**" | ||
- "**/README.md" | ||
- "CONTRIBUTING.md" | ||
release: | ||
types: | ||
- created | ||
workflow_call: | ||
|
||
jobs: | ||
check-api: | ||
name: Check API using ${{ matrix.sys.os }} ghc-${{ matrix.ghc }} | ||
runs-on: ${{ matrix.sys.os }} | ||
strategy: | ||
matrix: | ||
# we check API only on one platform and ghc release, since it shouldn't | ||
# vary elsewhere and the API tracer is sensitive to both | ||
sys: | ||
- { os: ubuntu-latest } | ||
ghc: | ||
[ | ||
# print-api only supports a small subset of ghc versions | ||
"9.6.6", | ||
] | ||
|
||
steps: | ||
|
||
- uses: actions/checkout@v4 | ||
|
||
- uses: haskell-actions/setup@v2 | ||
id: setup-haskell | ||
with: | ||
ghc-version: ${{ matrix.ghc }} | ||
cabal-version: 3.12.1.0 # see https://github.com/haskell/cabal/pull/10251 | ||
ghcup-release-channel: https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.8.yaml | ||
|
||
# I was going to use the canned action, but it only supports a single package and reinstalls the same binary each time | ||
- name: Install print-api | ||
run: | | ||
wget -q https://github.com/Kleidukos/print-api/releases/download/v0.1.0.1/print-api-0.1.0.1-Linux-static-${{ matrix.ghc }}-x86_64.tar.gz | ||
tar -xzvf print-api-0.1.0.1-Linux-static-${{ matrix.ghc }}-x86_64.tar.gz | ||
chmod +x print-api | ||
# print-api needs environment files. It also doesn't make a lot of sense to use the cached builds, sadly, | ||
# since they're special in different ways (bootstrap and validate) and we want a vanilla build. And there | ||
# isn't enough cache space to make a third cache, even though this is a very limited build. | ||
- name: Build Cabal with environment files | ||
run: cabal build Cabal-syntax Cabal --write-ghc-environment-files=always --project-file=cabal.release.project | ||
|
||
- name: Generate Cabal-syntax and Cabal APIs | ||
run: | | ||
./print-api --package-name Cabal-syntax > Cabal-syntax.api | ||
./print-api --package-name Cabal > Cabal.api | ||
# for convenience, since large changes would be a pain to reconstruct from diffs and | ||
# contributors aren't guaranteed to have ubuntu-latest handy | ||
# run this _before_ checking the API, so hopefully they're available on failure | ||
# because that's the point of making them artifacts! | ||
- uses: actions/upload-artifact@v4 | ||
with: | ||
name: Cabal-api | ||
path: '*.api' | ||
|
||
- name: Check Cabal-syntax and Cabal APIs | ||
run: | | ||
echo "Cabal-syntax API changes:" | ||
diff Cabal-syntax/Cabal-syntax-${{ matrix.ghc }}-${{ matrix.sys.os }}.api Cabal-syntax.api | ||
echo | ||
echo "Cabal API changes:" | ||
diff Cabal/Cabal-${{ matrix.ghc }}-${{ matrix.sys.os }}.api Cabal.api |
Oops, something went wrong.