Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.96 KB

DEVELOPER.md

File metadata and controls

59 lines (37 loc) · 1.96 KB
Raw

This document holds some useful information for developing Happy.

CI on GitHub Actions

2021-07-14

The GHC workflow file .github/workflows/haskell-ci.yml is generated by:

haskell-ci regenerate
patch --input=.github/haskell-ci.patch .github/workflows/haskell-ci.yml

The patch introduces happy specifics to the build and test process that are not covered by a vanilla instance of the haskell-ci workflow.

When new GHC versions become available, CI can be updated by

  • adding these versions to the tested-with field in happy.cabal (possibly removing obsolete minor versions)

  • generate the haskell-ci.yml by the steps above.

This should work as long as haskell-ci does not change its generated workflow too much. Otherwise, the patch might not apply cleanly and the workflow has to be patched manually.

2023-02-06 Updating to a new version of Haskell-CI

  1. Install Haskell-CI from its source repo:

     pushd /tmp
 git clone https://github.com/haskell-CI/haskell-ci.git
 cd haskell-ci
 cabal install
 popd

  2. Update the tested-with fields in the .cabal files.

  3. Follow the instructions to regenerate the Haskell CI workflow, which are:

     haskell-ci regenerate
 patch --input=.github/haskell-ci.patch .github/workflows/haskell-ci.yml

If some hunks fail to apply in the last step, the patch as to be updated.

  1. Apply the remaining hunks manually.

  2. Save the patched workflow, regenerate the original workflow, regenerate the patch

     cp .github/workflows/haskell-ci.yml .github/workflows/haskell-ci.yml-patched
 haskell-ci regenerate
 diff -u .github/workflows/haskell-ci.yml .github/workflows/haskell-ci.yml-patched > .github/haskell-ci.patch

  3. Now the patch will apply cleanly.

     patch --input=.github/haskell-ci.patch .github/workflows/haskell-ci.yml

  4. Commit the updated files (no extra files need to be committed).