Development

All you wanted to know about development.

Design decisions

Using Excepts as a beefed up ExceptT

This is an open variant, similar to plucky or oops and allows us to combine different error types. Maybe it is too much and it's a little bit unergonomic at times. If it really hurts maintenance, it will be removed. It was more of an experiment.

No use of haskell-TLS

I consider haskell-TLS an interesting experiment, but not a battle-tested and peer-reviewed crypto implementation. There is little to no research about what the intricacies of using haskell for low-level crypto are and how vulnerable such binaries are. Instead, we use either curl the binary (for FreeBSD and mac) or http-io-streams, which works with OpenSSL bindings.

Optics instead of lens

They're a little safer (less Monoid weirdness with view) and have better error messages. Consider the following wit lens

> view (_Just . to (++ "abc")) Nothing
""

vs optics

> view (_Just % to (++ "abc")) Nothing

<interactive>:2:1: error:
    • An_AffineFold cannot be used as A_Getter
    • In the expression: view (_Just % to (++ "abc")) Nothing
      In an equation for ‘it’: it = view (_Just % to (++ "abc")) Nothing

Strict and StrictData on by default

Kazu Yamamoto explained it in his PR very well. I like to agree with him. The instances where we need non-strict behavior, we annotate it.

Code style and formatting

Brittany
mtl-style preferred
no overly pointfree style

Code structure

Main functionality is in GHCup module. Utility functions are organised tree-ish in GHCup.Utils and GHCup.Utils.*.

Anything dealing with ghcup specific directories is in GHCup.Utils.Dirs.

Download information on where to fetch bindists from is in the appropriate yaml files: ghcup-<yaml-ver>.yaml.

Common Tasks

Adding a new GHC version

open the latest ghcup-<yaml-ver>.yaml
find the latest ghc version (in yaml tree e.g. ghcupDownloads -> GHC -> 8.10.3)
copy-paste it
adjust the version, tags, changelog, source url
adjust the various bindist urls (make sure to also change the yaml anchors)
run cabal run exe:ghcup-gen -- check-tarballs -f ghcup-<yaml-ver>.yaml -u 'ghc-8\.10\.4'

Major refactors

First major refactor included adding cross support. This added GHCTargetVersion, which includes the target in addition to the version. Most of the Version parameters to functions had to be replaced with that and ensured the logic is consistent for cross and non-cross installs.
This refactor added windows support wrt #130. The major changes here were switching hpath library out for filepath/directory (sadly) and introducing a non-unix way of handling processes via the process library. It also introduced considerable amounts of CPP wrt file handling, installation etc.

Releasing

Update version in ghcup.cabal and boostrap-haskell (ghver variable at the top of the script)
Update GHCup.Version module. ghcupURL must only be updated if we change the GHCupInfo type or the YAML representation of it. The version of the YAML represents the change increments. ghcUpVer is the current application version, read from ghcup.cabal.
Add ChangeLog entry
Add/fix downloads in ghcup-<ver>.yaml (under data/metadata), then verify with ghcup-gen check -f ghcup-<ver>.yaml and possibly (example only) ghcup-gen check-tarballs -f ghcup-<ver>.yaml -u 'ghc-8.10.7'. Generally, new GHC/cabal/stack/hls versions are only added to the latest yaml file. New GHCup versions are added to all (great care must be taken here to not break the parser... e.g. ARM platforms don't parse in all older formats).
Commit and git push with tag. Wait for tests to succeed and release artifacts to build.
Download release artifacts and upload them downloads.haskell.org/ghcup along with checksum files (sha256sum --tag * > SHA256SUMS && gpg --detach-sign -u <your-email> SHA256SUMS)
Add ghcup release artifacts to ALL yaml files (see point 4.)
Upload the final ghcup-<ver>.yaml to webhost.haskell.org/ghcup/data/.
Update bootstrap-haskell and bootstrap-haskell.ps1 to webhost.haskell.org/ghcup/sh/
Update the ghcup symlinks at downloads.haskell.org/ghcup

4.6 KiB Raw Permalink Blame History Unescape Escape