Skip to content

Commit

Permalink
singletons-{th,base}: Require building with GHC 9.12
Browse files Browse the repository at this point in the history
The most notable change is that because GHC 9.12 includes a fix for
https://gitlab.haskell.org/ghc/ghc/-/issues/24911, the test suite output now
includes explicit namespaces for its fixity declarations. Aside from that, the
changes here are mostly bumping upper version bounds.

Checks off one box in #619.
  • Loading branch information
RyanGlScott committed Dec 10, 2024
1 parent a8656d4 commit f27e294
Show file tree
Hide file tree
Showing 20 changed files with 209 additions and 171 deletions.
77 changes: 56 additions & 21 deletions .github/workflows/haskell-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ jobs:
strategy:
matrix:
include:
- compiler: ghc-9.12.0.20241128
compilerKind: ghc
compilerVersion: 9.12.0.20241128
setup-method: ghcup-prerelease
allow-failure: false
- compiler: ghc-9.10.1
compilerKind: ghc
compilerVersion: 9.10.1
Expand All @@ -38,9 +43,9 @@ jobs:
compilerVersion: 9.8.2
setup-method: ghcup
allow-failure: false
- compiler: ghc-9.6.5
- compiler: ghc-9.6.6
compilerKind: ghc
compilerVersion: 9.6.5
compilerVersion: 9.6.6
setup-method: ghcup
allow-failure: false
- compiler: ghc-9.4.8
Expand Down Expand Up @@ -117,6 +122,21 @@ jobs:
HCKIND: ${{ matrix.compilerKind }}
HCNAME: ${{ matrix.compiler }}
HCVER: ${{ matrix.compilerVersion }}
- name: Install GHC (GHCup prerelease)
if: matrix.setup-method == 'ghcup-prerelease'
run: |
"$HOME/.ghcup/bin/ghcup" config add-release-channel https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.8.yaml;
"$HOME/.ghcup/bin/ghcup" install ghc "$HCVER" || (cat "$HOME"/.ghcup/logs/*.* && false)
HC=$("$HOME/.ghcup/bin/ghcup" whereis ghc "$HCVER")
HCPKG=$(echo "$HC" | sed 's#ghc$#ghc-pkg#')
HADDOCK=$(echo "$HC" | sed 's#ghc$#haddock#')
echo "HC=$HC" >> "$GITHUB_ENV"
echo "HCPKG=$HCPKG" >> "$GITHUB_ENV"
echo "HADDOCK=$HADDOCK" >> "$GITHUB_ENV"
env:
HCKIND: ${{ matrix.compilerKind }}
HCNAME: ${{ matrix.compiler }}
HCVER: ${{ matrix.compilerVersion }}
- name: Set PATH and environment variables
run: |
echo "$HOME/.cabal/bin" >> $GITHUB_PATH
Expand All @@ -127,7 +147,7 @@ jobs:
echo "HCNUMVER=$HCNUMVER" >> "$GITHUB_ENV"
echo "ARG_TESTS=--enable-tests" >> "$GITHUB_ENV"
echo "ARG_BENCH=--enable-benchmarks" >> "$GITHUB_ENV"
echo "HEADHACKAGE=false" >> "$GITHUB_ENV"
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo "HEADHACKAGE=true" >> "$GITHUB_ENV" ; else echo "HEADHACKAGE=false" >> "$GITHUB_ENV" ; fi
echo "ARG_COMPILER=--$HCKIND --with-compiler=$HC" >> "$GITHUB_ENV"
env:
HCKIND: ${{ matrix.compilerKind }}
Expand Down Expand Up @@ -155,6 +175,18 @@ jobs:
repository hackage.haskell.org
url: http://hackage.haskell.org/
EOF
if $HEADHACKAGE; then
cat >> $CABAL_CONFIG <<EOF
repository head.hackage.ghc.haskell.org
url: https://ghc.gitlab.haskell.org/head.hackage/
secure: True
root-keys: 7541f32a4ccca4f97aea3b22f5e593ba2c0267546016b992dfadcd2fe944e55d
26021a13b401500c8eb2761ca95c61f2d625bfef951b939a8124ed12ecf07329
f76d08be13e9a61a377a85e2fb63f4c5435d40f8feb3e12eb05905edb8cdea89
key-threshold: 3
active-repositories: hackage.haskell.org, head.hackage.ghc.haskell.org:override
EOF
fi
cat >> $CABAL_CONFIG <<EOF
program-default-options
ghc-options: $GHCJOBS +RTS -M3G -RTS
Expand Down Expand Up @@ -185,9 +217,9 @@ jobs:
run: |
touch cabal.project
echo "packages: $GITHUB_WORKSPACE/source/./singletons" >> cabal.project
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "packages: $GITHUB_WORKSPACE/source/./singletons-th" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "packages: $GITHUB_WORKSPACE/source/./singletons-base" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "packages: $GITHUB_WORKSPACE/source/./singletons-base-code-generator" >> cabal.project ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo "packages: $GITHUB_WORKSPACE/source/./singletons-th" >> cabal.project ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo "packages: $GITHUB_WORKSPACE/source/./singletons-base" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000 && HCNUMVER < 91200)) -ne 0 ] ; then echo "packages: $GITHUB_WORKSPACE/source/./singletons-base-code-generator" >> cabal.project ; fi
cat cabal.project
- name: sdist
run: |
Expand All @@ -211,23 +243,26 @@ jobs:
touch cabal.project
touch cabal.project.local
echo "packages: ${PKGDIR_singletons}" >> cabal.project
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "packages: ${PKGDIR_singletons_th}" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "packages: ${PKGDIR_singletons_base}" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "packages: ${PKGDIR_singletons_base_code_generator}" >> cabal.project ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo "packages: ${PKGDIR_singletons_th}" >> cabal.project ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo "packages: ${PKGDIR_singletons_base}" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000 && HCNUMVER < 91200)) -ne 0 ] ; then echo "packages: ${PKGDIR_singletons_base_code_generator}" >> cabal.project ; fi
if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package singletons" >> cabal.project ; fi
if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo " ghc-options: -Werror=missing-methods" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "package singletons-th" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo " ghc-options: -Werror=missing-methods" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "package singletons-base" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo " ghc-options: -Werror=missing-methods" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "package singletons-base-code-generator" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo " ghc-options: -Werror=missing-methods" >> cabal.project ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo "package singletons-th" >> cabal.project ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo " ghc-options: -Werror=missing-methods" >> cabal.project ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo "package singletons-base" >> cabal.project ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then echo " ghc-options: -Werror=missing-methods" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000 && HCNUMVER < 91200)) -ne 0 ] ; then echo "package singletons-base-code-generator" >> cabal.project ; fi
if [ $((HCNUMVER >= 91000 && HCNUMVER < 91200)) -ne 0 ] ; then echo " ghc-options: -Werror=missing-methods" >> cabal.project ; fi
cat >> cabal.project <<EOF
source-repository-package
type: git
location: https://github.com/goldfirere/th-desugar
tag: 730a0ed799c91324d42b70d3780d6b3215cafc3c
EOF
if $HEADHACKAGE; then
echo "allow-newer: $($HCPKG list --simple-output | sed -E 's/([a-zA-Z-]+)-[0-9.]+/*:\1,/g')" >> cabal.project
fi
$HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: any.$_ installed\n" unless /^(Cabal|Cabal-syntax|singletons|singletons-base|singletons-base-code-generator|singletons-th)$/; }' >> cabal.project.local
cat cabal.project
cat cabal.project.local
Expand Down Expand Up @@ -255,12 +290,12 @@ jobs:
run: |
cd ${PKGDIR_singletons} || false
${CABAL} -vnormal check
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then cd ${PKGDIR_singletons_th} || false ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then ${CABAL} -vnormal check ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then cd ${PKGDIR_singletons_base} || false ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then ${CABAL} -vnormal check ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then cd ${PKGDIR_singletons_base_code_generator} || false ; fi
if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then ${CABAL} -vnormal check ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then cd ${PKGDIR_singletons_th} || false ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then ${CABAL} -vnormal check ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then cd ${PKGDIR_singletons_base} || false ; fi
if [ $((HCNUMVER >= 91200)) -ne 0 ] ; then ${CABAL} -vnormal check ; fi
if [ $((HCNUMVER >= 91000 && HCNUMVER < 91200)) -ne 0 ] ; then cd ${PKGDIR_singletons_base_code_generator} || false ; fi
if [ $((HCNUMVER >= 91000 && HCNUMVER < 91200)) -ne 0 ] ; then ${CABAL} -vnormal check ; fi
- name: haddock
run: |
$CABAL v2-haddock --disable-documentation $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ windows for requirements on the compiler version needed to build each library:
GHC language extensions, even more so than `singletons` itself. As such, it
is difficult to maintain support for multiple GHC versions in any given
release of either library, so they only support the latest major GHC version
(currently GHC 9.10).
(currently GHC 9.12).

Any code that uses the singleton-generation functionality from `singletons-th`
or `singletons-base` needs to enable a long list of GHC extensions. This list
Expand Down
1 change: 1 addition & 0 deletions singletons-base/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Changelog for the `singletons-base` project

3.5 [????.??.??]
-----------------
* Require building with GHC 9.12.
* Remove the use of a custom `Setup.hs` script. This script has now been
replaced with a [`cabal` code
generator](https://cabal.readthedocs.io/en/stable/cabal-package-description-file.html#pkg-field-test-suite-code-generators)
Expand Down
2 changes: 1 addition & 1 deletion singletons-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ that code with `singletons-base`.

`singletons-base` uses code that relies on bleeding-edge GHC language
extensions. As such, `singletons-base` only supports the latest major version
of GHC (currently GHC 9.10). For more information,
of GHC (currently GHC 9.12). For more information,
consult the `singletons`
[`README`](https://github.com/goldfirere/singletons/blob/master/README.md).

Expand Down
10 changes: 5 additions & 5 deletions singletons-base/singletons-base.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author: Richard Eisenberg <[email protected]>, Jan Stolarek <jan.stola
maintainer: Ryan Scott <[email protected]>
bug-reports: https://github.com/goldfirere/singletons/issues
stability: experimental
tested-with: GHC == 9.10.1
tested-with: GHC == 9.12.1
extra-doc-files: CHANGES.md
extra-source-files: README.md
tests/README.md
Expand Down Expand Up @@ -40,7 +40,7 @@ description:
.
@singletons-base@ uses code that relies on bleeding-edge GHC language
extensions. As such, @singletons-base@ only supports the latest major version
of GHC (currently GHC 9.10). For more information,
of GHC (currently GHC 9.12). For more information,
consult the @singletons@
@<https://github.com/goldfirere/singletons/blob/master/README.md README>@.
.
Expand All @@ -67,11 +67,11 @@ source-repository head

library
hs-source-dirs: src
build-depends: base >= 4.20 && < 4.21,
build-depends: base >= 4.21 && < 4.22,
pretty,
singletons == 3.0.*,
singletons-th >= 3.5 && < 3.6,
template-haskell >= 2.22.1 && < 2.23,
template-haskell >= 2.23 && < 2.24,
text >= 1.2,
th-desugar >= 1.18 && < 1.19
default-language: GHC2021
Expand Down Expand Up @@ -150,7 +150,7 @@ test-suite singletons-base-test-suite
main-is: SingletonsBaseTestSuite.hs
other-modules: SingletonsBaseTestSuiteUtils

build-depends: base >= 4.20 && < 4.21,
build-depends: base >= 4.21 && < 4.22,
bytestring >= 0.10.9,
deepseq >= 1.4.4,
filepath >= 1.3,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Singletons/Classes.hs:(0,0)-(0,0): Splicing declarations
type instance Apply @a @((~>) a Ordering) (<=>@#@$) a0123456789876543210 = (<=>@#@$$) a0123456789876543210
instance SuppressUnusedWarnings (<=>@#@$) where
suppressUnusedWarnings = snd ((,) (:<=>@#@$###) ())
infix 4 <=>@#@$
infix 4 type <=>@#@$
type (<=>@#@$$) :: forall a. a -> (~>) a Ordering
data (<=>@#@$$) (a0123456789876543210 :: a) :: (~>) a Ordering
where
Expand All @@ -154,11 +154,11 @@ Singletons/Classes.hs:(0,0)-(0,0): Splicing declarations
type instance Apply @a @Ordering ((<=>@#@$$) a0123456789876543210) a0123456789876543210 = (<=>) a0123456789876543210 a0123456789876543210
instance SuppressUnusedWarnings ((<=>@#@$$) a0123456789876543210) where
suppressUnusedWarnings = snd ((,) (:<=>@#@$$###) ())
infix 4 <=>@#@$$
infix 4 type <=>@#@$$
type (<=>@#@$$$) :: forall a. a -> a -> Ordering
type family (<=>@#@$$$) @a (a0123456789876543210 :: a) (a0123456789876543210 :: a) :: Ordering where
(<=>@#@$$$) a0123456789876543210 a0123456789876543210 = (<=>) a0123456789876543210 a0123456789876543210
infix 4 <=>@#@$$$
infix 4 type <=>@#@$$$
type TFHelper_0123456789876543210 :: forall a. a -> a -> Ordering
type family TFHelper_0123456789876543210 @a (a :: a) (a :: a) :: Ordering where
TFHelper_0123456789876543210 @a (a_0123456789876543210 :: a) (a_0123456789876543210 :: a) = Apply (Apply MycompareSym0 a_0123456789876543210) a_0123456789876543210
Expand Down Expand Up @@ -248,7 +248,7 @@ Singletons/Classes.hs:(0,0)-(0,0): Splicing declarations
(%<=>) ::
(forall (t :: a) (t :: a).
Sing t -> Sing t -> Sing ((<=>) t t :: Ordering) :: Type)
infix 4 %<=>
infix 4 data %<=>
default (%<=>) ::
(forall (t :: a) (t :: a).
(((<=>) t t :: Ordering) ~ TFHelper_0123456789876543210 t t) =>
Expand Down
16 changes: 8 additions & 8 deletions singletons-base/tests/compile-and-dump/Singletons/Fixity.golden
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Singletons/Fixity.hs:(0,0)-(0,0): Splicing declarations
type instance Apply @a @((~>) a a) (====@#@$) a0123456789876543210 = (====@#@$$) a0123456789876543210
instance SuppressUnusedWarnings (====@#@$) where
suppressUnusedWarnings = snd ((,) (:====@#@$###) ())
infix 4 ====@#@$
infix 4 type ====@#@$
type (====@#@$$) :: a -> (~>) a a
data (====@#@$$) (a0123456789876543210 :: a) :: (~>) a a
where
Expand All @@ -32,11 +32,11 @@ Singletons/Fixity.hs:(0,0)-(0,0): Splicing declarations
type instance Apply @a @a ((====@#@$$) a0123456789876543210) a0123456789876543210 = (====) a0123456789876543210 a0123456789876543210
instance SuppressUnusedWarnings ((====@#@$$) a0123456789876543210) where
suppressUnusedWarnings = snd ((,) (:====@#@$$###) ())
infix 4 ====@#@$$
infix 4 type ====@#@$$
type (====@#@$$$) :: a -> a -> a
type family (====@#@$$$) @a (a0123456789876543210 :: a) (a0123456789876543210 :: a) :: a where
(====@#@$$$) a0123456789876543210 a0123456789876543210 = (====) a0123456789876543210 a0123456789876543210
infix 4 ====@#@$$$
infix 4 type ====@#@$$$
type (====) :: a -> a -> a
type family (====) @a (a :: a) (a :: a) :: a where
(====) a _ = a
Expand All @@ -48,7 +48,7 @@ Singletons/Fixity.hs:(0,0)-(0,0): Splicing declarations
type instance Apply @a @((~>) a Ordering) (<=>@#@$) a0123456789876543210 = (<=>@#@$$) a0123456789876543210
instance SuppressUnusedWarnings (<=>@#@$) where
suppressUnusedWarnings = snd ((,) (:<=>@#@$###) ())
infix 4 <=>@#@$
infix 4 type <=>@#@$
type (<=>@#@$$) :: forall a. a -> (~>) a Ordering
data (<=>@#@$$) (a0123456789876543210 :: a) :: (~>) a Ordering
where
Expand All @@ -57,14 +57,14 @@ Singletons/Fixity.hs:(0,0)-(0,0): Splicing declarations
type instance Apply @a @Ordering ((<=>@#@$$) a0123456789876543210) a0123456789876543210 = (<=>) a0123456789876543210 a0123456789876543210
instance SuppressUnusedWarnings ((<=>@#@$$) a0123456789876543210) where
suppressUnusedWarnings = snd ((,) (:<=>@#@$$###) ())
infix 4 <=>@#@$$
infix 4 type <=>@#@$$
type (<=>@#@$$$) :: forall a. a -> a -> Ordering
type family (<=>@#@$$$) @a (a0123456789876543210 :: a) (a0123456789876543210 :: a) :: Ordering where
(<=>@#@$$$) a0123456789876543210 a0123456789876543210 = (<=>) a0123456789876543210 a0123456789876543210
infix 4 <=>@#@$$$
infix 4 type <=>@#@$$$
class PMyOrd a where
type family (<=>) (arg :: a) (arg :: a) :: Ordering
infix 4 %====
infix 4 data %====
(%====) ::
(forall (t :: a) (t :: a).
Sing t -> Sing t -> Sing ((====) t t :: a) :: Type)
Expand All @@ -80,7 +80,7 @@ Singletons/Fixity.hs:(0,0)-(0,0): Splicing declarations
(%<=>) ::
(forall (t :: a) (t :: a).
Sing t -> Sing t -> Sing ((<=>) t t :: Ordering) :: Type)
infix 4 %<=>
infix 4 data %<=>
instance SMyOrd a =>
SingI ((<=>@#@$) :: (~>) a ((~>) a Ordering)) where
sing = singFun2 @(<=>@#@$) (%<=>)
Expand Down
Loading

0 comments on commit f27e294

Please sign in to comment.