Merge branch 'wasm-3.0' of github.com:WebAssembly/spec into wasm-3.0

WebAssembly · Sep 25, 2024 · 264d2ad · 264d2ad
2 parents 386269e + a315401
commit 264d2ad
Show file tree

Hide file tree

Showing 191 changed files with 10,674 additions and 1,290 deletions.
diff --git a/.github/workflows/ci-spec.yml b/.github/workflows/ci-spec.yml
@@ -35,13 +35,44 @@ 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
 
-  build-legacy-exceptions-spec:
+  build-js-api-spec:
     runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+      - 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@v4
+        with:
+          name: js-api-rendered
+          path: document/js-api/index.html
+
+  build-web-api-spec:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+      - 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@v4
+        with:
+          name: web-api-rendered
+          path: document/web-api/index.html
+
+  build-code-metadata-spec:
+    runs-on: ubuntu-latest
+    needs: [build-core-spec]
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
@@ -52,71 +83,108 @@ jobs:
       - name: Setup Sphinx
         run: pip install six && pip install sphinx==5.1.0
       - name: Build main spec
-        run: cd document/legacy/exceptions && make main
+        run: cd document/metadata/code && make main
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
-          name: legacy-exceptions-rendered
-          path: document/legacy/exceptions/_build/html
+          name: code-metadata-rendered
+          path: document/metadata/code/_build/html
 
-  build-js-api-spec:
+  build-legacy-exceptions-core-spec:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
-      - 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"
+        with:
+          submodules: "recursive"
+      - name: Setup TexLive
+        run: sudo apt-get update -y && sudo apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
+      - name: Setup Sphinx
+        run: pip install six && pip install sphinx==5.1.0
+      - 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: js-api-rendered
-          path: document/js-api/index.html
+          name: legacy-exceptions-core-rendered
+          path: document/legacy/exceptions/core/_build/html
 
-  build-web-api-spec:
+  build-legacy-exceptions-js-api-spec:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
       - 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"
+        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: web-api-rendered
-          path: document/web-api/index.html
+          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@v2
+      - 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-legacy-exceptions-spec, build-js-api-spec, build-web-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
       - 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 legacy exceptions spec artifact
-        uses: actions/download-artifact@v2
-        with:
-          name: legacy-exceptions-rendered
-          path: _output/legacy/exceptions
       - 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@v4
+        with:
+          name: code-metadata-rendered
+          path: _output/metadata/code
+      - name: Download legacy exceptions core spec artifact
+        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@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

diff --git a/.github/workflows/mirror-to-master.yml b/.github/workflows/mirror-to-master.yml
diff --git a/.github/workflows/w3c-publish.yml b/.github/workflows/w3c-publish.yml
@@ -5,8 +5,23 @@ on:
     branches: [ main ]
     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:
+      w3c-status:
+        required: true
+        type: choice
+        description: W3C Document Status
+        options:
+          - ED
+          - WD
+          - CRD
+          - CR
 
 jobs:
   publish-to-w3c-TR:
@@ -30,7 +45,7 @@ jobs:
       - name: Publish all specs to their https://www.w3.org/TR/ URLs
         run: cd document && make -e WD-echidna-CI
         env:
-          STATUS: --md-status=WD
+          W3C_STATUS: ${{ github.event_name == 'push' && 'CRD' || inputs.w3c-status }}
           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 }}

diff --git a/README.md b/README.md
@@ -32,18 +32,11 @@ Original README from upstream repository follows.
 
 # spec
 
-This repository holds a prototypical reference implementation for WebAssembly,
-which is currently serving as the official specification. Eventually, we expect
-to produce a specification either written in human-readable prose or in a formal
-specification language.
+This repository holds the sources for the WebAssembly specification,
+a reference implementation, and the official test suite.
 
-It also holds the WebAssembly testsuite, which tests numerous aspects of
-conformance to the spec.
-
-View the work-in-progress spec at [webassembly.github.io/spec](https://webassembly.github.io/spec/).
-
-At this time, the contents of this repository are under development and known
-to be "incomplet and inkorrect".
+A formatted version of the spec is available here:
+[webassembly.github.io/spec](https://webassembly.github.io/spec/),
 
 Participation is welcome. Discussions about new features, significant semantic
 changes, or any specification change likely to generate substantial discussion

diff --git a/deploy_key b/deploy_key
diff --git a/deploy_key.pub b/deploy_key.pub
diff --git a/document/LICENSE b/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/
diff --git a/document/Makefile b/document/Makefile
@@ -1,4 +1,4 @@
-DIRS     = core js-api web-api 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-%=%)/