learn4haskell icon indicating copy to clipboard operation
learn4haskell copied to clipboard

Useful to have docker instructions in README.md?

Open bitwombat opened this issue 4 years ago • 3 comments

I have Haskell already installed on my system, and that includes stack but not cabal. So, in order to run the tests for this course, I installed ghcup in Docker, then cabal, and ran the tests there.

Would a PR with instructions for how to do this be useful? Or a Dockerfile even?

bitwombat avatar Nov 16 '21 23:11 bitwombat

@bitwombat I'm afraid, we don't have the capacity to maintain Docker instructions in our repository. We use cabal-install, so if anything changes in how we build the project, we will need to update Docker instructions as well and this is extra work.

Also, I believe it should be relatively easy to build the project with stack and run relevant tests. We don't maintain stack because we use only cabal but currently, all the cabal-install instructions should be portable to stack as well.

chshersh avatar Nov 18 '21 22:11 chshersh

I definitely wouldn't want to add to the maintenance burden for this nice little project you have gifted to the Haskell world!

The Dockerfile would just install ghcup and run cabal update as per the current instructions. So it would use your existing .cabal file. The maintenance would be in bumping the ghc versions in two places (the ghcup lines in your instructions).

But, yeah, I was just seeing if your team lit up at the possibility (and then I'd make it). No matter how I made it, it would add to the maintenance burden... unless I made an image and put it on dockerhub and you just pointed to it in your README.md?

bitwombat avatar Nov 18 '21 23:11 bitwombat

@bitwombat That sounds good 👍🏻 In that case, could you add Dockerfile directly to this repo, instructions to README.md (how to use this file and when one want to use it) and how to upgrade this file (e.g. by bumping up the GHC version)? That should do it 🙂

chshersh avatar Nov 21 '21 13:11 chshersh