cherry pick changes from playground fix (#235)

Author: anmonteiro

.github/workflows/publish-version.yml

@@ -14,6 +14,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
+        with:
+          submodules: recursive
       - name: Setup Node
         uses: actions/setup-node@v6
         with:
@@ -22,19 +24,28 @@ jobs:
       - uses: ocaml/setup-ocaml@v3
         with:
           ocaml-compiler: 5.4.0
+          opam-pin: false
           dune-cache: false # can cause trouble when generating melange docs in step below: https://github.com/ocaml/dune/issues/7720
       - name: Install all deps
         run: make install
-      - name: Generate melange docs
-        run: opam reinstall -y melange --with-doc --keep-build-dir
-      - name: Copy melange docs in ml syntax
+      - name: Check vendored sources exist
+        run: |
+          test -d melange
+          test -d reason-react
+      - name: Generate melange docs in ml syntax
         run: |
+          ODOC_SYNTAX="ml" opam exec -- dune build --root melange @doc
           mkdir -p docs/public/api/
-          cp -r `opam var melange:build`/_build/default/_doc/_html docs/public/api/ml
+          cp -r melange/_build/default/_doc/_html docs/public/api/ml
       - name: Generate melange docs in re syntax
-        run: ODOC_SYNTAX="re" opam reinstall -y melange --with-doc --keep-build-dir
-      - name: Copy melange docs in re syntax
-        run: cp -r `opam var melange:build`/_build/default/_doc/_html docs/public/api/re
+        run: |
+          opam exec -- dune clean --root melange
+          ODOC_SYNTAX="re" opam exec -- dune build --root melange @doc
+          cp -r melange/_build/default/_doc/_html docs/public/api/re
+      - name: Build playground assets
+        run: |
+          opam exec -- dune build melange/melange.install
+          opam exec -- dune build @playground-assets
       # only uncomment after a new version is released, from inside a `x.x.x-patches` branch
       # - name: Run canonical script
       #   run: opam exec -- dune exec add_canonical docs/public/api

.gitignore

@@ -7,5 +7,3 @@ node_modules
 docs/.vitepress/cache
 docs/.vitepress/dist
 docs/public/playground
-
-melange

.gitmodules

@@ -0,0 +1,7 @@
+[submodule "melange"]
+	path = melange
+	url = https://github.com/melange-re/melange.git
+	branch = v6-54
+[submodule "reason-react"]
+	path = reason-react
+	url = https://github.com/reasonml/reason-react.git

Makefile

@@ -17,12 +17,14 @@ create-switch: ## Create opam switch
 .PHONY: init
 init: create-switch install ## Configure everything to develop this repository in local
 
+.PHONY: init-submodules
+init-submodules:
+	git submodule update --init --recursive
+
 .PHONY: install
-install: ## Install development dependencies
+install: init-submodules ## Install development dependencies
 	opam update
 	opam install -y . --deps-only --with-doc
-	opam pin -y add $(project_name).dev .
-	opam source melange.$$(opam show melange -f version --color never) --dir melange
 
 .PHONY: check-reason
 check-reason: ## Checks that Reason syntax snippets are well formed

README.md

@@ -11,19 +11,21 @@ https://github.com/melange-re/melange.
 
 ## Working locally
 
-After cloning the repository, install the necessary JavaScript packages:
+After cloning the repository, initialize submodules and install the necessary JavaScript packages:
 
 ```bash
+git submodule update --init --recursive
 yarn
 ```
 
 Then run `make dev` from the folder where the repository lives.
 
 ## (Optional) Fetch melange documentation API
 
-Optionally, to fetch the melange odoc documentation and generate markdown into docs/api, you will need the melange package installed into your switch and run:
+Optionally, to generate melange odoc documentation markdown into docs/api, initialize the vendored `melange` submodule and run:
 
 ```bash
+git submodule update --init --recursive
 make pull-melange-docs SYNTAX="re"
 make pull-melange-docs SYNTAX="ml"
 ```

documentation-site.opam

@@ -14,11 +14,9 @@ license: "MIT"
 homepage: "https://github.com/melange-re/melange-re.github.io"
 bug-reports: "https://github.com/melange-re/melange-re.github.io/issues"
 depends: [
+  "dune" {>= "3.8"}
   "ocaml"
-  "dune" {>= "3.8" & >= "3.8"}
   "reason" {>= "3.17"}
-  "reason-react"
-  "reason-react-ppx"
   "ocamlformat"
   "js_of_ocaml"
   "cmarkit" {dev}
@@ -40,8 +38,3 @@ build: [
   ]
 ]
 dev-repo: "git+https://github.com/melange-re/melange-re.github.io.git"
-pin-depends: [
-  [ "reason-react-ppx.dev" "git+https://github.com/reasonml/reason-react.git#8f49cb937cdafcc4e2d83a2edcca66aa24bf8e20"]
-  [ "reason-react.dev" "git+https://github.com/reasonml/reason-react.git#8f49cb937cdafcc4e2d83a2edcca66aa24bf8e20"]
-  [ "dune.dev" "git+https://github.com/ocaml/dune.git#e7ca9f7f2652761b77dd687787436bdd31b1571c"]
-]

dune

@@ -1 +1 @@
-(vendored_dirs melange)
+(vendored_dirs melange reason-react)

dune-project

@@ -15,16 +15,17 @@
  "Antonio Nuno Monteiro <anmonteiro@gmail.com>"
  "Javier Chávarri <javier.chavarri@gmail.com>")
 
+(homepage "https://github.com/melange-re/melange-re.github.io")
+
+(bug_reports "https://github.com/melange-re/melange-re.github.io/issues")
+
 (package
  (name documentation-site)
  (synopsis "Melange documentation site")
  (description "Content for the Melange documentation site")
  (depends
   ocaml
-  (dune (>= 3.8))
   (reason (>= 3.17))
-  reason-react
-  reason-react-ppx
   ocamlformat
   js_of_ocaml
   (cmarkit :dev)

flake.nix

@@ -32,31 +32,6 @@
                         runHook postBuild
                       '';
                     });
-                    melange = osuper.melange.overrideAttrs (_: {
-                      src = super.fetchFromGitHub {
-                        owner = "melange-re";
-                        repo = "melange";
-                        rev = "0c7fbb6b6734d54e60b7e73d2d696ec31e90a0c8";
-                        fetchSubmodules = true;
-                        hash = "sha256-HOLqyVCfHfpbJwcrYH1M1jT8Y6v45oFG42SKJVYJm/4=";
-                      };
-                    });
-                    melange-playground =
-                      with oself;
-                      buildDunePackage {
-                        pname = "melange-playground";
-                        inherit (melange) src version;
-                        nativeBuildInputs = [
-                          cppo
-                          js_of_ocaml
-                        ];
-                        propagatedBuildInputs = [
-                          js_of_ocaml-compiler
-                          melange
-                          reason
-                          reason-react-ppx
-                        ];
-                      };
                   }
                 );
               }
@@ -98,8 +73,8 @@
               dune
               ocaml
               findlib
-              melange
-              melange-playground
+              js_of_ocaml
+              js_of_ocaml-compiler
               reason
             ];
             buildInputs =
@@ -110,8 +85,6 @@
                 pkgs.yarn
               ]
               ++ (with pkgs.ocamlPackages; [
-                reason-react
-                reason-react-ppx
                 ocamlformat
                 js_of_ocaml
                 cmarkit