feat: deploy via respec (#41)

* feat: deploy via respec * fix: duplicate releases such that paths match w3id redirects
eclipse-dataspace-protocol-base · Oct 9, 2024 · 3cbf47d · 3cbf47d
1 parent f968c6c
commit 3cbf47d
Show file tree

Hide file tree

Showing 5 changed files with 161 additions and 47 deletions.
diff --git a/.github/workflows/autopublish.yaml b/.github/workflows/autopublish.yaml
@@ -0,0 +1,42 @@
+name: Auto-Publish
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build and Validate
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+      - name: Inject md to html
+        run: |
+          chmod +x ./scripts/replace.sh
+          ./scripts/replace.sh
+      - name: Run Respec
+        run:
+          sudo npx puppeteer browsers install chrome
+          npx respec --src index.html --out index.html.build.html -t 60 --disable-sandbox --verbose
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: .
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,8 @@
 
 .DS_Store
 .env
+
+index.html
+/message
+/2024-1
+/v0.8
diff --git a/scripts/replace.sh b/scripts/replace.sh
@@ -0,0 +1,25 @@
+cp scripts/respec-template.html index.html
+mkdir ./message/diagram -p
+cp ./**/message/diagram/*.png ./message/diagram/
+cp ./releases/* . -r
+index=`cat index.html`
+ovph="THIS IS THE PLACEHOLDER FOR THE OVERVIEW"
+modph="THIS IS THE PLACEHOLDER FOR THE MODEL"
+comph="THIS IS THE PLACEHOLDER FOR THE COMMON FUNCTIONALITIES"
+cataph="THIS IS THE PLACEHOLDER FOR THE CATALOG PROTOCOL"
+cnph="THIS IS THE PLACEHOLDER FOR THE CONTRACT NEGOTIATION PROTOCOL"
+tpph="THIS IS THE PLACEHOLDER FOR THE TRANSFER PROCESS PROTOCOL"
+ov=`cat README.md`
+mod="`cat model/terminology.md`"$'\n\n'"`cat model/model.md`"
+cata="`cat catalog/catalog.protocol.md`"$'\n\n'"`cat catalog/catalog.binding.https.md`"
+com="`cat common/common.protocol.md`"$'\n\n'"`cat common/common.binding.https.md`"
+cata="`cat catalog/catalog.protocol.md`"$'\n\n'"`cat catalog/catalog.binding.https.md`"
+cn="`cat negotiation/contract.negotiation.protocol.md`"$'\n\n'"`cat negotiation/contract.negotiation.binding.https.md`"
+tp="`cat transfer/transfer.process.protocol.md`"$'\n\n'"`cat transfer/transfer.process.binding.https.md`"
+index="${index/$ovph/"$ov"}"
+index="${index/$modph/"$mod"}"
+index="${index/$comph/"$com"}"
+index="${index/$cataph/"$cata"}"
+index="${index/$cnph/"$cn"}"
+index="${index/$tpph/"$tp"}"
+echo "$index" > index.html -e
diff --git a/scripts/respec-template.html b/scripts/respec-template.html
@@ -0,0 +1,89 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<head>
+    <meta charset='utf-8'>
+    <script src='https://www.w3.org/Tools/respec/respec-w3c' async class='remove'></script>
+    <script class='remove'>
+        var respecConfig = {
+          specStatus: "unofficial",
+          editors: [{
+              name: "Sebastian Steinbuss",
+              url: "https://github.com/ssteinbuss",
+              company: "International Dataspaces Association",
+              companyURL: "https://internationaldataspaces.org/",
+          }],
+          github: {
+            branch: "main",
+            repoURL: "eclipse-dataspace-protocol-base/DataspaceProtocol",
+          },
+          xref: "web-platform",
+          lint: { "no-unused-dfns": false },
+          format: "markdown"
+        };
+    </script>
+    <title>Dataspace Protocol Release 2024-1</title>
+</head>
+<body>
+<p class="copyright">
+    This document is licensed under <a href="https://www.apache.org/licenses/LICENSE-2.0.html">The Apache License, Version 2.0</a>.
+</p>
+<h1 id="title">Dataspace Protocol</h1>
+<section id='abstract'>
+    <p>
+        The Dataspace Protocol is a set of specifications designed to facilitate interoperable data sharing between
+        entities governed by usage control and based on Web technologies. These specifications define the schemas and
+        protocols required for entities to publish data, negotiate Agreements, and access data as part of a federation
+        of technical systems termed a Dataspace.
+    </p>
+</section>
+<section id='sotd'>
+    <p>
+        This version (2024-1) of the Dataspace Protocol specification is the release candidate and considered to be
+        stable. Further changes shall not affect conformity. Since <a href="https://github.com/International-Data-Spaces-Association/ids-specification/tree/main/releases/v0.8">version 0.8</a>
+        the specification is stable with changes in details. All changes made to the specification can be reviewed in
+        the GitHub repository.
+    </p>
+</section>
+
+<section>
+
+THIS IS THE PLACEHOLDER FOR THE OVERVIEW
+
+</section>
+
+<section>
+
+THIS IS THE PLACEHOLDER FOR THE MODEL
+
+</section>
+
+<section>
+
+THIS IS THE PLACEHOLDER FOR THE COMMON FUNCTIONALITIES
+
+</section>
+
+<section>
+
+THIS IS THE PLACEHOLDER FOR THE CATALOG PROTOCOL
+
+</section>
+<section>
+
+THIS IS THE PLACEHOLDER FOR THE CONTRACT NEGOTIATION PROTOCOL
+
+</section>
+
+<section>
+
+THIS IS THE PLACEHOLDER FOR THE TRANSFER PROCESS PROTOCOL
+
+</section>
+
+<section id='conformance'></section>
+<section id="tof" class="appendix">
+    <h1>Notes</h1>
+</section>
+
+</body>
+</html>