Build fully static compiler binary using ghc-musl by purefunctor · Pull Request #4573 · purescript/purescript

purefunctor · Apr 9, 2025

Description of the change

Closes #4572.

Checklist:

Added a file to CHANGELOG.d for this PR (see CHANGELOG.d/README.md)
Added myself to CONTRIBUTORS.md (if this is my first contribution)
Linked any existing issues or proposals that this pull request should close
Updated or added relevant documentation
Added a test for the contribution (if applicable)

purefunctor · Apr 16, 2025

Next task to do on my end is to verify the licenses of the various dependencies that we're using to make sure that we can statically link against them. I'm on a Mac at the moment so I can't test the static build of the compiler on the daily but it passing all tests and building the package set is very promising.

.github/workflows/ci.yml

benz0li · Apr 23, 2025

@purefunctor Regarding statically linked Linux binaries:

GMP licensing restrictions

The regular GHC musl images produce binaries linked against the GNU Multiple Precision Arithmetic Library (GMP), which is used by default by the integer-gmp library to provide a big-integer implementation for Haskell.

Unlike most Haskell code, which is licensed under the permissive BSD3 license, the GMP library is licensed under LGPL. This means resulting statically linked binaries must be provided with source code or object files.

If that is not acceptable for your situation, use images with the int-native subtag. These images provide a GHC that links against the Haskell-native big-integer backend and produces statically linked binaries that and are not
subject to GMP's licensing restrictions.
ℹ️ Available for versions 9.6.7, 9.8.4, 9.10.1, 9.12.2 and later.

– https://github.com/benz0li/ghc-musl#gmp-licensing-restrictions

Cross reference:

FAQ - The Haskell Tool Stack > What is licensing restrictions on Windows?
https://www.gnu.org/licenses/gpl-faq.html#LGPLStaticVsDynamic

Does the LGPL have different requirements for statically vs dynamically linked modules with a covered work?
For the purpose of complying with the LGPL (any extant version: v2, v2.1 or v3):

(1) If you statically link against an LGPLed library, you must also provide your application in an object (not necessarily source) format, so that a user has the opportunity to modify the library and relink the application.

(2) If you dynamically link against an LGPLed library already present on the user's computer, you need not convey the library's source. [...]

purefunctor · May 17, 2025

Hi @benz0li, many thanks for the information about licensing and apologies for the late response.

Following suit from stack and pandoc, I believe the next steps would be:

to specify that Linux builds may statically link against GMP
to add a copy of LGPL/GPL to the LICENSE file
to specify links for the compiler's and GMP's source code

After which we should be ready to distribute statically-linked binaries.

Thoughts on this @rhendric @f-f ?

f-f · Jun 8, 2025

@purefunctor very happy to have static binaries 😄

purefunctor · Jun 17, 2025

This PR is now ready for review! I'm also happy to take on updating https://github.com/purescript/npm-installer (and other distributions) to point to the new static binaries.

purefunctor

Added comments on a few points of discussion

purefunctor · Jun 17, 2025

.github/workflows/ci.yml

            build --fast --ghc-options -fwrite-ide-info

-      - run: "ci/fix-home stack exec weeder"
+      - run: "ci/fix-home stack exec weeder -- --hie-directory .stack-work"


weeder-2.8.0 seemed to have been reliant on a bug that matched . directories by default. See context here

purefunctor · Jun 17, 2025

ci/build.sh

 # We test with --haddock because haddock generation can fail if there is invalid doc-comment syntax,
 # and these failures are very easy to miss otherwise.
-STACK="stack --no-terminal --haddock --jobs=2"
+STACK="stack --no-terminal --haddock --jobs=4"


Seems fine to use at most 4 cores:
https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories

purefunctor · Jun 17, 2025

purescript.cabal

+  build-tool-depends:
+    happy:happy ==2.0.2


I think this was declared before in the purescript-cst library—not having it makes cabal builds fail on my machine though!

purefunctor · Jun 17, 2025

purescript.cabal

    filepath >=1.4.301.0 && <1.5,
    Glob >=0.10.2 && <0.11,
-    haskeline ==0.8.2,
+    haskeline >=0.8.2.1 && <0.9,


This fixes cabal builds but also introduces libtinfo to dynamically-linked executables.

This is fine for local builds if we only build the static one in CI

.github/workflows/ci.yml

f-f · Jun 22, 2025

purescript.cabal

    filepath >=1.4.301.0 && <1.5,
    Glob >=0.10.2 && <0.11,
-    haskeline ==0.8.2,
+    haskeline >=0.8.2.1 && <0.9,


This is fine for local builds if we only build the static one in CI

purefunctor · Jun 22, 2025

It works!

f-f

Looks great now - thanks @purefunctor!

f-f · Jun 25, 2025

@purefunctor I have updated the CI requirements to include the new jobs, so the path ahead is all green - are we good to merge?

purefunctor · Jun 25, 2025

Let's go for it! I'll make a post on the discourse soon

…

On Thu, Jun 26, 2025, 02:54 Fabrizio Ferrai ***@***.***> wrote: *f-f* left a comment (purescript/purescript#4573) <#4573 (comment)> @purefunctor <https://github.com/purefunctor> I have updated the CI requirements to include the new jobs, so the path ahead is all green - are we good to merge? — Reply to this email directly, view it on GitHub <#4573 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AP46GXFQRXZRX4Q3T6CGSF33FLV5RAVCNFSM6AAAAAB2ZXJSMOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTAMBVHAYTOOBYGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

* Build statically-linked binaries with ghc-musl * Compliance for LGPL terms * Add changelog entry * Update dependencies * Update LICENSE * Update weeder * Fix weeder * Add more changelog entries * Argument passthrough * Update license * Update license * Build images for ARM * Checkout after Node installation * Only mount volumes for static * Drop static prefix for now * Force purge cache * Remove builds against ubuntu * Use matrix.os for cache key * Fix linux only * Set CI_STATIC to true * CI_STATIC on Linux only * Fix more linux only checks

purefunctor force-pushed the justin/ghc-musl branch from 80eb9e3 to 997aded Compare April 9, 2025 18:57

purefunctor mentioned this pull request Apr 10, 2025

Upgrade to GHC 9.6.6 #4568

Merged

9 tasks

purefunctor force-pushed the justin/ghc-musl branch from c9bbd05 to 137a4fc Compare April 10, 2025 10:42

benz0li reviewed Apr 20, 2025

View reviewed changes

.github/workflows/ci.yml Outdated Show resolved Hide resolved

purefunctor force-pushed the justin/ghc-musl branch from 24b6467 to cfc51fd Compare May 17, 2025 20:29

Build statically-linked binaries with ghc-musl

8c4944b

purefunctor force-pushed the justin/ghc-musl branch from cfc51fd to 8c4944b Compare May 17, 2025 20:33

purefunctor added 11 commits June 17, 2025 00:12

Compliance for LGPL terms

e186bf9

Add changelog entry

137f46e

Merge branch 'master' into justin/ghc-musl

cb5227f

Update dependencies

ab956b0

Update LICENSE

e64ffeb

Update weeder

b789271

Fix weeder

f0ffb3a

Add more changelog entries

1b50065

Argument passthrough

f109eaf

Update license

9bdd8da

Update license

85c8318

purefunctor commented Jun 17, 2025

View reviewed changes

f-f reviewed Jun 22, 2025

View reviewed changes

purefunctor added 4 commits June 23, 2025 00:47

Build images for ARM

e120c00

Checkout after Node installation

d473068

Only mount volumes for static

60bce67

Merge branch 'master' into justin/ghc-musl

fe6b60f

purefunctor added 4 commits June 23, 2025 02:20

Drop static prefix for now

4973fbc

Force purge cache

7e1d642

Remove builds against ubuntu

ed0b227

Use matrix.os for cache key

7743b43

purefunctor force-pushed the justin/ghc-musl branch from 96b36f9 to c0ae072 Compare June 23, 2025 04:58

Fix linux only

0ebc33c

purefunctor force-pushed the justin/ghc-musl branch from c0ae072 to 0ebc33c Compare June 23, 2025 05:01

purefunctor added 3 commits June 23, 2025 13:02

Set CI_STATIC to true

197dba2

CI_STATIC on Linux only

0758eec

Fix more linux only checks

d3ddcee

f-f approved these changes Jun 25, 2025

View reviewed changes

purefunctor merged commit 9dd761a into master Jun 27, 2025
13 of 14 checks passed

purefunctor deleted the justin/ghc-musl branch June 27, 2025 05:21

Search code, repositories, users, issues, pull requests...

Conversation

purefunctor commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

purefunctor commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

benz0li commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

GMP licensing restrictions

Uh oh!

purefunctor commented May 17, 2025

Uh oh!

f-f commented Jun 8, 2025

Uh oh!

purefunctor commented Jun 17, 2025

Uh oh!

purefunctor left a comment

Choose a reason for hiding this comment

Uh oh!

purefunctor Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

purefunctor Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

purefunctor Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

purefunctor Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

f-f Jun 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

f-f Jun 22, 2025

Choose a reason for hiding this comment

Uh oh!

purefunctor commented Jun 22, 2025

Uh oh!

f-f left a comment

Choose a reason for hiding this comment

Uh oh!

f-f commented Jun 25, 2025

Uh oh!

purefunctor commented Jun 25, 2025 via email

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

purefunctor commented Apr 9, 2025 •

edited

Loading

purefunctor commented Apr 16, 2025 •

edited

Loading

benz0li commented Apr 23, 2025 •

edited

Loading