Add a feature for Haskell (GHC) #470

brendandburns · 2023-03-02T19:54:53Z

No description provided.

bamurtaugh · 2023-03-02T20:09:19Z

Hi @brendandburns, thanks so much for the PR!

We try to keep a small subset of languages in this repo. We then absolutely welcome further community-published contributions to our Feature index.

Would you be interested in publishing this Feature in your own repo (i.e. at https://github.com/brendandburns/ghc-feature) and then opening a PR to update our index? We have a sample repo that walks through the process.

Let us know if you have any questions, thank you!

brendandburns · 2023-03-02T21:12:05Z

@bamurtaugh I'm happy to put it in a separate repo and indeed, I've already published some features here, so I'm familiar with the process.

https://github.com/dev-wasm/dev-wasm-feature

However in this case it seems odd to have an independent repo for a (relatively) mainstream language, since it will lead to a variety of different people implementing the same things. How does the team decide which languages to support?

I'm happy to sign up to be a maintainer of this. However, if it truly doesn't fit in this repo, I will do it as a separate feature.

bamurtaugh · 2023-03-02T23:08:23Z

However in this case it seems odd to have an independent repo for a (relatively) mainstream language, since it will lead to a variety of different people implementing the same things. How does the team decide which languages to support?

Thanks for opening this dialogue, this is a great question.

For broader context (especially if other folks may discover this PR):

We previously hosted all dev container templates and features in one large mono-repo: https://github.com/microsoft/vscode-dev-containers/tree/main/containers. This became difficult to manage as our maintainer group doesn't have expertise in each language, and it became especially challenging in the case of issues that needed quick turnaround time.

When we moved to the open spec, we saw that as a great opportunity to move to a more distributed, community-involved model, hoping to avoid the mono-repo issues we had faced for a few years. When determining which languages to bring over, we looked at a variety of data points and usage trends to determine overall language popularity and usage of our existing artifacts (i.e. templates and features).

I'm happy to sign up to be a maintainer of this. However, if it truly doesn't fit in this repo, I will do it as a separate feature.

As we've been discussing, we'd love for you to be a maintainer! We're actively working on this now. Thank you so much for your contributions so far and your interest in maintaining longer term, we're really excited to collaborate with you.

@samruddhikhandale @joshspicer if you have any specific feedback on the contents of this Feature, it'd be great to get your review, thank you!

samruddhikhandale

Thank you for the contribution, we appreciate it 🎉

Left some comments/thoughts!

src/haskell/devcontainer-feature.json

src/haskell/install.sh

test/haskell/scenarios.json

eitsupi · 2023-03-03T07:55:30Z

src/haskell/install.sh

+# Maybe install curl, gcc, make
+for x in curl gcc make; do
+    which $x > /dev/null || (apt update && apt install $x -y -qq)
+done


It would be better to use a generic snippet to check other Features to do this.

I don't quite follow this comment, can you clarify?

Thanks!

I believe @eitsupi is referring to using check_packages helper function instead of this logic.
https://github.com/devcontainers/features/blob/main/src/docker-in-docker/install.sh#LL86-L91C2

I think it would be nice to use check_packages in this Feature as well for consistency.
(Would also need to copy apt_get_update along with check_packages)

Hrm, I'm not sure that those scripts do exactly what I want to do here. For example, they won't work correctly on a non-debian image where gcc is already installed.

Additionally, copying functions from one install.sh to another doesn't seem to be a great practice, is there a way to share common script snippets between features?

I'm not sure that those scripts do exactly what I want to do here. For example, they won't work correctly on a non-debian image where gcc is already installed.

Note that this repository is focused on debian-based containers at this time. Most Features will only work with debian-based images.

features/README.md

Line 32 in 1449f41

"image": "mcr.microsoft.com/devcontainers/base:ubuntu", // Any generic, debian-based image.

Additionally, copying functions from one install.sh to another doesn't seem to be a great practice, is there a way to share common script snippets between features?

See devcontainers/spec#209

brendandburns · 2023-03-08T23:02:06Z

Comments addressed except one I didn't quite understand. Please take another look.

brendandburns · 2023-03-08T23:16:07Z

So it appears that there is something different about the mcr:ubuntu and mcr:debian images which is causing failures.

Is there a good way I can test other than just trying to create a container with that as the base image?

src/haskell/install.sh

test/haskell/default_version.sh

src/haskell/install.sh

samruddhikhandale · 2023-03-08T23:29:17Z

src/haskell/install.sh

+done
+
+GHCUP_DIR=~/.ghcup/bin
+mkdir -p $GHCUP_DIR


I wonder if we should add a new user group haskell and chown & set sticky bit for this folder .ghcup

Ref: https://github.com/devcontainers/features/blob/main/src/ruby/install.sh#LL206-L209C7 &
https://github.com/devcontainers/features/blob/main/src/ruby/install.sh#L283-L285

where

USERNAME="${USERNAME:-"${_REMOTE_USER:-"automatic"}"}"

We have https://github.com/devcontainers/features/blob/main/src/ruby/install.sh#L39-L59 to automatically figure out the USERNAME

I'm not sure it's necessary, this will land in the home directory, but it doesn't really need a different username imho.

src/haskell/install.sh

brendandburns · 2023-03-11T00:33:08Z

@samruddhikhandale comments mostly addressed except the creating a new haskell user which doesn't seem necessary, and also the standardized package install.

I'm open to a more standard package install solution if it is 100% required, but it seems not super useful to just cut and paste the same thing into multiple locations. Additionally, I think we would need to edit it so that it doesn't require a deb based package manager.

But I'm motivated to get this merged :) so if those changes are required, let me know and I will make them.

eitsupi · 2023-03-11T03:19:20Z

But I'm motivated to get this merged :)

I don't think there is any chance at all that this repository will merge this PR.
Please check the README.

features/README.md

Lines 98 to 111 in 1449f41

    
           ## Contributions 
        
           ### Creating your own collection of Features 
        
           The [Feature distribution specification](https://containers.dev/implementors/features-distribution/) outlines a pattern for community members and organizations to self-author Features in repositories they control. 
        
           A template repo [`devcontainers/feature-template`](https://github.com/devcontainers/feature-template) and [GitHub Action](https://github.com/devcontainers/action) are available to help bootstrap self-authored Features. 
        
           We are eager to hear your feedback on self-authoring!  Please provide comments and feedback on [spec issue #70](https://github.com/devcontainers/spec/issues/70). 
        
           ### Contributing to this repository 
        
           This repository will accept improvement and bug fix contributions related to the 
        
           [current set of maintained Features](./src).

So the standard practice is for you to create your own repository and manage it there.
For example, I manage the Features to install R in https://github.com/rocker-org/devcontainer-features.

But if you would prefer to manage this in a multi-person organization rather than managing this on your own, @jcbhmr and I are discussing in https://github.com/orgs/devcontainers-community/discussions/1 about creating such a repository. (I am not sure if such a repository or organization will really materialize.)

eitsupi · 2023-03-11T03:24:21Z

Cross ref microsoft/vscode-dev-containers#1705

jcbhmr · 2023-03-11T23:31:34Z

@brendandburns Would it be worth reaching out to https://github.com/haskell somehow? Maybe via https://github.com/haskell/meta to ask if they can add your code to like a haskell/devcontainer-features or similar repo? I know there has been some discussion about what to do about non-@devcontainers features and stuff, and one of the ideas was to put the features under the tooling/language organization. They already offer what appear to be "official" GitHub Actions https://github.com/haskell/actions so it might not be that much of a stretch to ask about devcontainer stuff?

/cc @eitsupi

bamurtaugh · 2023-03-21T18:30:33Z

Thanks so much everyone for the brainstorming and reviews here- I really appreciate everyone providing their feedback and collaborating to find the best path forward.

@brendandburns is joining us as a spec maintainer, and the thinking here is his direct spec involvement, plus long-standing container and Haskell expertise, allows the spec to host this Feature (avoids the mono-repo / language expertise issues of vscode-dev-containers).

I also think the suggestion to work with Haskell to host the Feature directly is quite interesting - I really appreciate folks sharing that idea. I've opened this issue in the Haskell repo: haskell/meta#4, and we'll continue sharing updates in this PR.

samruddhikhandale

Looks great, thank you so much! ✨ ✨

hasufell · 2023-03-22T01:06:04Z

src/haskell/install.sh

+
+export GHCUP_INSTALL_BASE_PREFIX=${_REMOTE_USER_HOME}
+
+${GHCUP_DIR}/ghcup install ghc $BOOTSTRAP_HASKELL_GHC_VERSION


I suggest to not do all this manually, but use the bootstrap script, which allows fine grained control via env vars.

E.g.

curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | BOOTSTRAP_HASKELL_NONINTERACTIVE=1 BOOTSTRAP_HASKELL_CABAL_VERSION=$CABALVERSION BOOTSTRAP_HASKELL_INSTALL_HLS=1 BOOTSTRAP_HASKELL_ADJUST_BASHRC=1 sh

This will also try do adjust shell config to add ~/.ghcup/bin to PATH and most importantly install stack installation hooks that make sure HLS actually works with stack (there are ABI issues). See https://www.haskell.org/ghcup/guide/#strategy-2-stack-hooks-new-recommended

Right now the bootstrap script assumes you want latest of stack and HLS, but I can add environment variables to control that as well.

Oh and the bootstrap script also creates a ~/.ghcup/env file that can be sourced to get the correct PATH.

hasufell · 2023-03-22T01:09:02Z

src/haskell/install.sh

+set -e
+set -o xtrace
+
+GHCUP_VERSION="0.1.19.2"


Yeah, please use the bootstrap script to always get the latest ghcup. Pinning ghcup version is not recommended.

hasufell · 2023-03-22T01:10:06Z

test/haskell/custom_version.sh

+
+# Definition specific tests
+check "version" ~/.ghcup/bin/ghc --version | grep 9.2.6
+


So is ~/.ghcup/bin in PATH?

hasufell · 2023-03-22T01:19:37Z

src/haskell/devcontainer-feature.json

+    "options": {
+        "version": {
+            "type": "string",
+            "proposals": [


I'm not too familiar with how features work. My feeling is that this list can become outdated quickly. For HLS, it already is. Would it not be enough to choose between recommended and latest? Can the user enter manual strings regardless?

Add a feature for Haskell (GHC)

c6c62b2

brendandburns requested a review from a team as a code owner March 2, 2023 19:54

samruddhikhandale requested changes Mar 2, 2023

View reviewed changes

eitsupi reviewed Mar 3, 2023

View reviewed changes

Updates for comments.

580b154

samruddhikhandale reviewed Mar 8, 2023

View reviewed changes

src/haskell/install.sh Show resolved Hide resolved

src/haskell/install.sh Outdated Show resolved Hide resolved

src/haskell/install.sh Outdated Show resolved Hide resolved

samruddhikhandale reviewed Mar 8, 2023

View reviewed changes

test/haskell/default_version.sh Show resolved Hide resolved

samruddhikhandale reviewed Mar 8, 2023

View reviewed changes

src/haskell/install.sh Outdated Show resolved Hide resolved

samruddhikhandale reviewed Mar 8, 2023

View reviewed changes

src/haskell/install.sh Show resolved Hide resolved

brendandburns added 2 commits March 10, 2023 15:00

Address more comments.

b6f48a9

Updates for comments

e1f52b2

brendandburns force-pushed the main branch from 64c4143 to e1f52b2 Compare March 11, 2023 00:16

eitsupi mentioned this pull request Mar 11, 2023

Simplified haskell devcontainer. microsoft/vscode-dev-containers#1705

Open

bamurtaugh mentioned this pull request Mar 21, 2023

Dev Container Feature for Haskell haskell/meta#4

Open

samruddhikhandale approved these changes Mar 21, 2023

View reviewed changes

hasufell reviewed Mar 22, 2023

View reviewed changes

eitsupi mentioned this pull request Aug 1, 2023

Haskell - ghcup not installing correctly microsoft/vscode-dev-containers#1692

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a feature for Haskell (GHC) #470

Add a feature for Haskell (GHC) #470

brendandburns commented Mar 2, 2023

bamurtaugh commented Mar 2, 2023

brendandburns commented Mar 2, 2023

bamurtaugh commented Mar 2, 2023

samruddhikhandale left a comment

eitsupi Mar 3, 2023

brendandburns Mar 8, 2023

samruddhikhandale Mar 8, 2023

brendandburns Mar 10, 2023

eitsupi Mar 11, 2023

brendandburns commented Mar 8, 2023

brendandburns commented Mar 8, 2023

samruddhikhandale Mar 8, 2023

samruddhikhandale Mar 8, 2023

brendandburns Mar 11, 2023

brendandburns commented Mar 11, 2023

eitsupi commented Mar 11, 2023

eitsupi commented Mar 11, 2023

jcbhmr commented Mar 11, 2023 •

edited

Loading

bamurtaugh commented Mar 21, 2023

samruddhikhandale left a comment

hasufell Mar 22, 2023

hasufell Mar 22, 2023

hasufell Mar 22, 2023

hasufell Mar 22, 2023

hasufell Mar 22, 2023


		export GHCUP_INSTALL_BASE_PREFIX=${_REMOTE_USER_HOME}

		${GHCUP_DIR}/ghcup install ghc $BOOTSTRAP_HASKELL_GHC_VERSION


		# Definition specific tests
		check "version" ~/.ghcup/bin/ghc --version \| grep 9.2.6

Add a feature for Haskell (GHC) #470

Are you sure you want to change the base?

Add a feature for Haskell (GHC) #470

Conversation

brendandburns commented Mar 2, 2023

bamurtaugh commented Mar 2, 2023

brendandburns commented Mar 2, 2023

bamurtaugh commented Mar 2, 2023

samruddhikhandale left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brendandburns commented Mar 8, 2023

brendandburns commented Mar 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brendandburns commented Mar 11, 2023

eitsupi commented Mar 11, 2023

eitsupi commented Mar 11, 2023

jcbhmr commented Mar 11, 2023 • edited Loading

bamurtaugh commented Mar 21, 2023

samruddhikhandale left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcbhmr commented Mar 11, 2023 •

edited

Loading