Add automation for Solid Project publication

.github/workflows/tr-draft-config.yml

@@ -0,0 +1,87 @@
+# Workflow for moving the editor's draft into published form
+
+name: Format as CG Draft
+on:
+  push:
+    tags:
+      - solid-oidc-draft-[0-9]+
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.8'
+
+      - name: Upgrade pip
+        run: python3 -m pip install --upgrade pip
+
+      - name: Install Bikeshed
+        run: |
+          python3 -m pip install --upgrade bikeshed
+          bikeshed update
+
+      - name: Adjust document status to CG-DRAFT
+        run: |
+          sed -i 's|w3c/ED|w3c/CG-DRAFT|g' index.bs
+          sed -i 's|w3c/ED|w3c/CG-DRAFT|g' primer/index.bs
+
+      - name: Generate HTML
+        run: for bsdoc in ./*.bs ./**/*.bs; do bikeshed spec $bsdoc; done
+
+      - name: Generate SVG
+        run: for diagram in ./*.mmd primer/*.mmd; do docker run --rm -v "$PWD:/data" minlag/mermaid-cli -i /data/$diagram; done
+
+      - name: Create publication
+        shell: bash
+        run: |
+          mkdir publish
+          cp index.html ./publish/oidc.html
+          cp sequence.mmd.svg ./publish/oidc-sequence.svg
+          sed -i "s|sequence.mmd.svg|oidc-sequence.svg|g" ./publish/oidc.html
+          sed -i "s|https://solid.github.io/solid-oidc/solid.svg|https://solidproject.org/TR/solid.svg|g" ./publish/oidc.html
+          sed -i "s|https://solid.github.io/solid-oidc/primer/|https://solidproject.org/TR/oidc-primer|g" ./publish/oidc.html
+          sed -i "s|https://solid.github.io/solid-oidc/|https://solidproject.org/TR/oidc|g" ./publish/oidc.html
+
+          cp primer/index.html ./publish/oidc-primer.html
+          cp primer/primer-login.mmd.svg ./publish/oidc-primer-login.svg
+          cp primer/primer-request.mmd.svg ./publish/oidc-primer-request.svg
+          sed -i "s|primer-login.mmd.svg|oidc-primer-login.svg|g" ./publish/oidc-primer.html
+          sed -i "s|primer-request.mmd.svg|oidc-primer-request.svg|g" ./publish/oidc-primer.html
+          sed -i "s|https://solid.github.io/solid-oidc/solid.svg|https://solidproject.org/TR/solid.svg|g" ./publish/oidc-primer.html
+          sed -i "s|https://solid.github.io/solid-oidc/primer/|https://solidproject.org/TR/oidc-primer|g" ./publish/oidc-primer.html
+          sed -i "s|https://solid.github.io/solid-oidc/|https://solidproject.org/TR/oidc|g" ./publish/oidc-primer.html
+
+          # Perform the same tasks for a date-specific version
+          YEAR=$(date '+%Y')
+          DAY=$(date '+%Y%m%d')
+          mkdir ./publish/$YEAR
+
+          cp index.html ./publish/$YEAR/oidc-$DAY.html
+          cp sequence.mmd.svg ./publish/$YEAR/oidc-sequence-$DAY.svg
+          sed -i "s|sequence.mmd.svg|oidc-sequence-$DAY.svg|g" ./publish/$YEAR/oidc-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/solid.svg|https://solidproject.org/TR/solid.svg|g" ./publish/$YEAR/oidc-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/primer/|https://solidproject.org/TR/oidc-primer|g" ./publish/$YEAR/oidc-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/|https://solidproject.org/TR/$YEAR/oidc-$DAY|g" ./publish/$YEAR/oidc-$DAY.html
+
+          cp primer/index.html ./publish/$YEAR/oidc-primer-$DAY.html
+          cp primer/primer-login.mmd.svg ./publish/$YEAR/oidc-primer-login-$DAY.svg
+          cp primer/primer-request.mmd.svg ./publish/$YEAR/oidc-primer-request-$DAY.svg
+          sed -i "s|primer-login.mmd.svg|oidc-primer-login-$DAY.svg|g" ./publish/$YEAR/oidc-primer-$DAY.html
+          sed -i "s|primer-request.mmd.svg|oidc-primer-request-$DAY.svg|g" ./publish/$YEAR/oidc-primer-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/solid.svg|https://solidproject.org/TR/solid.svg|g" ./publish/$YEAR/oidc-primer-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/primer/|https://solidproject.org/TR/$YEAR/oidc-primer-$DAY|g" ./publish/$YEAR/oidc-primer-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/|https://solidproject.org/TR/oidc|g" ./publish/$YEAR/oidc-primer-$DAY.html
+
+      - name: Publish to TR Publication branch
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_dir: ./publish
+          publish_branch: solid-tr-publication
+          personal_token: ${{ secrets.GITHUB_TOKEN }}
+

.github/workflows/tr-final-config.yml

@@ -0,0 +1,87 @@
+# Workflow for moving the editor's draft into published form
+
+name: Format as CG Final
+on:
+  push:
+    tags:
+      - solid-oidc-final-[0-9]+
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.8'
+
+      - name: Upgrade pip
+        run: python3 -m pip install --upgrade pip
+
+      - name: Install Bikeshed
+        run: |
+          python3 -m pip install --upgrade bikeshed
+          bikeshed update
+
+      - name: Adjust document status to CG-FINAL
+        run: |
+          sed -i 's|w3c/ED|w3c/CG-FINAL|g' index.bs
+          sed -i 's|w3c/ED|w3c/CG-FINAL|g' primer/index.bs
+
+      - name: Generate HTML
+        run: for bsdoc in ./*.bs ./**/*.bs; do bikeshed spec $bsdoc; done
+
+      - name: Generate SVG
+        run: for diagram in ./*.mmd primer/*.mmd; do docker run --rm -v "$PWD:/data" minlag/mermaid-cli -i /data/$diagram; done
+
+      - name: Create publication
+        shell: bash
+        run: |
+          mkdir publish
+          cp index.html ./publish/oidc.html
+          cp sequence.mmd.svg ./publish/oidc-sequence.svg
+          sed -i "s|sequence.mmd.svg|oidc-sequence.svg|g" ./publish/oidc.html
+          sed -i "s|https://solid.github.io/solid-oidc/solid.svg|https://solidproject.org/TR/solid.svg|g" ./publish/oidc.html
+          sed -i "s|https://solid.github.io/solid-oidc/primer/|https://solidproject.org/TR/oidc-primer|g" ./publish/oidc.html
+          sed -i "s|https://solid.github.io/solid-oidc/|https://solidproject.org/TR/oidc|g" ./publish/oidc.html
+
+          cp primer/index.html ./publish/oidc-primer.html
+          cp primer/primer-login.mmd.svg ./publish/oidc-primer-login.svg
+          cp primer/primer-request.mmd.svg ./publish/oidc-primer-request.svg
+          sed -i "s|primer-login.mmd.svg|oidc-primer-login.svg|g" ./publish/oidc-primer.html
+          sed -i "s|primer-request.mmd.svg|oidc-primer-request.svg|g" ./publish/oidc-primer.html
+          sed -i "s|https://solid.github.io/solid-oidc/solid.svg|https://solidproject.org/TR/solid.svg|g" ./publish/oidc-primer.html
+          sed -i "s|https://solid.github.io/solid-oidc/primer/|https://solidproject.org/TR/oidc-primer|g" ./publish/oidc-primer.html
+          sed -i "s|https://solid.github.io/solid-oidc/|https://solidproject.org/TR/oidc|g" ./publish/oidc-primer.html
+
+          # Perform the same tasks for a date-specific version
+          YEAR=$(date '+%Y')
+          DAY=$(date '+%Y%m%d')
+          mkdir ./publish/$YEAR
+
+          cp index.html ./publish/$YEAR/oidc-$DAY.html
+          cp sequence.mmd.svg ./publish/$YEAR/oidc-sequence-$DAY.svg
+          sed -i "s|sequence.mmd.svg|oidc-sequence-$DAY.svg|g" ./publish/$YEAR/oidc-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/solid.svg|https://solidproject.org/TR/solid.svg|g" ./publish/$YEAR/oidc-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/primer/|https://solidproject.org/TR/oidc-primer|g" ./publish/$YEAR/oidc-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/|https://solidproject.org/TR/$YEAR/oidc-$DAY|g" ./publish/$YEAR/oidc-$DAY.html
+
+          cp primer/index.html ./publish/$YEAR/oidc-primer-$DAY.html
+          cp primer/primer-login.mmd.svg ./publish/$YEAR/oidc-primer-login-$DAY.svg
+          cp primer/primer-request.mmd.svg ./publish/$YEAR/oidc-primer-request-$DAY.svg
+          sed -i "s|primer-login.mmd.svg|oidc-primer-login-$DAY.svg|g" ./publish/$YEAR/oidc-primer-$DAY.html
+          sed -i "s|primer-request.mmd.svg|oidc-primer-request-$DAY.svg|g" ./publish/$YEAR/oidc-primer-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/solid.svg|https://solidproject.org/TR/solid.svg|g" ./publish/$YEAR/oidc-primer-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/primer/|https://solidproject.org/TR/$YEAR/oidc-primer-$DAY|g" ./publish/$YEAR/oidc-primer-$DAY.html
+          sed -i "s|https://solid.github.io/solid-oidc/|https://solidproject.org/TR/oidc|g" ./publish/$YEAR/oidc-primer-$DAY.html
+
+      - name: Publish to TR Publication branch
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_dir: ./publish
+          publish_branch: solid-tr-publication
+          personal_token: ${{ secrets.GITHUB_TOKEN }}
+

README.md

@@ -20,3 +20,25 @@ in all of these interactions.
 * [Specification](https://solid.github.io/solid-oidc/)
 * [Primer](https://solid.github.io/solid-oidc/primer/)
 
+## Releasing a new Solid-OIDC Draft Report
+
+Creating a new Solid-OIDC draft report for submission to the Solid Specification is simple.
+One must only create a new tag in the repository:
+
+    $ git tag -s solid-oidc-draft-04 -m "Solid-OIDC Community Group Draft Report 04"
+    $ git push origin solid-oidc-draft-04
+
+Now the GitHub automation will run and produce a formatted version of the Solid-OIDC
+specification in the `solid-tr-publication` branch. Pull this branch to your local
+environment and copy the files present into the `solid/specification` repository,
+submitting a pull request with these changes.
+
+## Releasing a new Solid-OIDC Final Report
+
+The process of creating a Community Group final report is exactly the same as with
+creating a draft report, only the tag is slightly different:
+
+    $ git tag -s solid-oidc-final-02 -m "Solid-OIDC Community Group Final Report 02"
+    $ git push origin solid-oidc-final-02
+
+The same process applies to adding this to the `solid/specification` repository.