Merge remote-tracking branch 'spec/wasm-3.0'

Author: eqrion

.github/workflows/ci-interpreter.yml

@@ -2,11 +2,11 @@ name: CI for interpreter & tests
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, wasm-3.0 ]
     paths: [ .github/**, interpreter/**, test/** ]
 
   pull_request:
-    branches: [ main ]
+    branches: [ main, wasm-3.0 ]
     paths: [ .github/**, interpreter/**, test/** ]
 
   # Allows you to run this workflow manually from the Actions tab
@@ -17,17 +17,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup OCaml
-        uses: ocaml/setup-ocaml@v2
+        uses: ocaml/setup-ocaml@v3
         with:
           ocaml-compiler: 4.14.x
       - name: Setup OCaml tools
         run: opam install --yes ocamlfind.1.9.5 js_of_ocaml.4.0.0 js_of_ocaml-ppx.4.0.0
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
-          node-version: 19.x
+          node-version: 20.x
       - name: Build interpreter
         run: cd interpreter && opam exec make
       - name: Run tests

.github/workflows/ci-spec.yml

@@ -2,11 +2,11 @@ name: CI for specs
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, wasm-3.0 ]
     paths: [ .github/**, document/** ]
 
   pull_request:
-    branches: [ main ]
+    branches: [ main, wasm-3.0 ]
     paths: [ .github/**, document/** ]
 
   # Allows you to run this workflow manually from the Actions tab
@@ -17,11 +17,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: "recursive"
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 16
       - name: Setup Bikeshed
@@ -35,7 +35,7 @@ jobs:
       - name: Run Bikeshed
         run: cd document/core && make bikeshed
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: core-rendered
           path: document/core/_build/html
@@ -44,13 +44,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Bikeshed
         run: pip install bikeshed && bikeshed update
       - name: Run Bikeshed
         run: bikeshed spec "document/js-api/index.bs" "document/js-api/index.html"
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: js-api-rendered
           path: document/js-api/index.html
@@ -59,13 +59,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Bikeshed
         run: pip install bikeshed && bikeshed update
       - name: Run Bikeshed
         run: bikeshed spec "document/web-api/index.bs" "document/web-api/index.html"
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: web-api-rendered
           path: document/web-api/index.html
@@ -75,7 +75,7 @@ jobs:
     needs: [build-core-spec]
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: "recursive"
       - name: Setup TexLive
@@ -85,7 +85,7 @@ jobs:
       - name: Build main spec
         run: cd document/metadata/code && make main
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: code-metadata-rendered
           path: document/metadata/code/_build/html
@@ -94,7 +94,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: "recursive"
       - name: Setup TexLive
@@ -104,7 +104,7 @@ jobs:
       - name: Build main spec
         run: cd document/legacy/exceptions/core && make main
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: legacy-exceptions-core-rendered
           path: document/legacy/exceptions/core/_build/html
@@ -119,52 +119,75 @@ jobs:
       - name: Run Bikeshed
         run: bikeshed spec "document/legacy/exceptions/js-api/index.bs" "document/legacy/exceptions/js-api/index.html"
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: legacy-exceptions-js-api-rendered
           path: document/legacy/exceptions/js-api/index.html
 
+  build-spec-versions:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: versions-rendered
+          path: document/versions/
+
   publish-spec:
     runs-on: ubuntu-latest
-    needs: [build-core-spec, build-js-api-spec, build-web-api-spec, build-code-metadata-spec, build-legacy-exceptions-core-spec, build-legacy-exceptions-js-api-spec]
+    needs:
+      - build-core-spec
+      - build-js-api-spec
+      - build-web-api-spec
+      - build-code-metadata-spec
+      - build-legacy-exceptions-core-spec
+      - build-legacy-exceptions-js-api-spec
+      - build-spec-versions
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Create output directory
         run: mkdir _output && cp document/index.html _output/index.html
       - name: Download core spec artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: core-rendered
           path: _output/core
       - name: Download JS API spec artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: js-api-rendered
           path: _output/js-api
       - name: Download Web API spec artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: web-api-rendered
           path: _output/web-api
       - name: Download code metadata spec artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: code-metadata-rendered
           path: _output/metadata/code
       - name: Download legacy exceptions core spec artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: legacy-exceptions-core-rendered
           path: _output/legacy/exceptions/core
       - name: Download legacy exceptions JS API spec artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: legacy-exceptions-js-api-rendered
           path: _output/legacy/exceptions/js-api
+      - name: Download spec versions artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: versions-rendered
+          path: _output/versions
       - name: Publish to GitHub Pages
         if: github.ref == 'refs/heads/main'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           publish_dir: ./_output
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/w3c-publish.yml

@@ -1,37 +1,76 @@
-name: Publish to W3C TR space
+name: Validate/Publish to W3C TR space
 
 on:
   push:
     branches: [ main ]
     paths: [ .github/**, document/** ]
+  pull_request:
+    paths: [ .github/**, document/** ]
 
-  # Allows you to run this workflow manually from the Actions tab
+  # Allows you to run this workflow manually from the Actions tab, gh CLI tool,
+  # or REST API. THe w3c-status options correspond to the valid options for
+  # Bikeshed's --md-status flag, and refer to the W3C rec-track document
+  # stages described in https://www.w3.org/policies/process/#maturity-stages
+  # (Editor's Draft, Working Draft, Candidiate Recommendation Draft, and
+  # Candidate Recommendation Snapshot).
   workflow_dispatch:
+    inputs:
+      dry-run:
+        required: true
+        type: boolean
+        description: If set, Echidna will validate but not publish.
+      w3c-status:
+        required: true
+        type: choice
+        description: W3C Document Status
+        options:
+          - ED
+          - WD
+          - CRD
+          - CR
+
+env:
+  YARN_ENABLE_IMMUTABLE_INSTALLS: false
+  W3C_STATUS: ${{ github.event_name == 'workflow_dispatch' && inputs.w3c-status || 'CRD' }}
 
 jobs:
   publish-to-w3c-TR:
-    if: github.repository == 'WebAssembly/spec'
+    strategy:
+      fail-fast: false
+      matrix:
+        spec: [core, js-api, web-api]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: "recursive"
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 16
       - name: Setup Bikeshed
         run: pip install bikeshed && bikeshed update
       - name: Setup TexLive
+        if: ${{ matrix.spec == 'core' }}
         run: sudo apt-get update -y && sudo apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
       - name: Setup Sphinx
+        if: ${{ matrix.spec == 'core' }}
         run: pip install six && pip install sphinx==5.1.0
-      - name: Publish all specs to their https://www.w3.org/TR/ URLs
-        run: cd document && make -e WD-echidna-CI
+      - name: Publish ${{ matrix.spec }} spec to its https://www.w3.org/TR/ URL
+        if: env.W3C_ECHIDNA_TOKEN_CORE
+        run: cd document && make -e -C ${{ matrix.spec }} WD-echidna-CI
         env:
-          STATUS: --md-status=WD
           W3C_ECHIDNA_TOKEN_CORE: ${{ secrets.W3C_ECHIDNA_TOKEN_CORE }}
           W3C_ECHIDNA_TOKEN_JSAPI: ${{ secrets.W3C_ECHIDNA_TOKEN_JSAPI }}
           W3C_ECHIDNA_TOKEN_WEBAPI: ${{ secrets.W3C_ECHIDNA_TOKEN_WEBAPI }}
-          YARN_ENABLE_IMMUTABLE_INSTALLS: false
+          # Publish the draft on manual dispatches without dry-run set, or on pushes to the main branch.
+          ECHIDNA_DRYRUN: |-
+            ${{ !((github.event_name == 'workflow_dispatch' && !inputs.dry-run) ||
+                  (github.event_name == 'push' && github.repository == 'WebAssembly/spec' && github.ref == 'refs/heads/main')) }}
+      - name: Validate ${{ matrix.spec }} spec with Echidna
+        if: env.W3C_USERNAME
+        run: cd document && make -e -C ${{ matrix.spec }} WD-echidna
+        env:
+          W3C_USERNAME: ${{ secrets.W3C_USERNAME }}
+          W3C_PASSWORD: ${{ secrets.W3C_PASSWORD }}

document/LICENSE

@@ -0,0 +1,2 @@
+This document is licensed under the W3C Software and Document License.
+Its text can be found at https://www.w3.org/copyright/software-license/

document/Makefile

@@ -1,4 +1,4 @@
-DIRS     = core js-api web-api metadata/code legacy/exceptions
+DIRS     = core js-api web-api metadata/code legacy/exceptions versions
 FILES    = index.html
 BUILDDIR = _build
 TAR      = tar
@@ -28,21 +28,21 @@ diff: $(DIRS:%=diff-%)
 # macOS: do “brew install tar” & run “make” as: TAR=gtar make -e WD-tar
 .PHONY: WD-tar
 WD-tar:
-	for dir in $(DIRS); \
-		do STATUS=--md-status=WD TAR=$(TAR) $(MAKE) -e -C $$dir $@;\
+	for dir in $(DIRS); do \
+		TAR=$(TAR) $(MAKE) -e -C $$dir $@ || exit 1; \
 	done
 
 # macOS: do “brew install tar” & run “make” as: TAR=gtar make -e WD-echidna
 .PHONY: WD-echidna
 WD-echidna:
-	for dir in $(DIRS); \
-		do $(MAKE) -e -C $$dir $@;\
+	for dir in $(DIRS); do \
+		$(MAKE) -e -C $$dir $@ || exit 1; \
 	done
 
 .PHONY: WD-echidna-CI
 WD-echidna-CI:
-	for dir in $(DIRS); \
-		do $(MAKE) -e -C $$dir $@;\
+	for dir in $(DIRS); do \
+		$(MAKE) -e -C $$dir $@ || exit 1; \
 	done
 
 # Directory-specific targets.
@@ -60,7 +60,7 @@ $(DIRS:%=build-%): build-%:
 	(cd $(@:build-%=%); make BUILDDIR=$(BUILDDIR) all)
 
 .PHONY: $(DIRS:%=dir-%)
-$(DIRS:%=dir-%): dir-%:
+$(DIRS:%=dir-%): dir-%: $(BUILDDIR)
 	mkdir -p $(BUILDDIR)/$(@:dir-%=%)
 	rm -rf $(BUILDDIR)/$(@:dir-%=%)/*
 	cp -R $(@:dir-%=%)/$(BUILDDIR)/html/* $(BUILDDIR)/$(@:dir-%=%)/