From d346a1c5c68823255b2992b1837dacb5c012fd1e Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 14:21:09 -0400 Subject: [PATCH 01/10] Add automation for Solid Project publication --- .github/workflows/publication-config.yml | 65 ++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 .github/workflows/publication-config.yml diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml new file mode 100644 index 0000000..230eea7 --- /dev/null +++ b/.github/workflows/publication-config.yml @@ -0,0 +1,65 @@ +# Workflow for moving the editor's draft into published form + +name: Format as CG Draft +on: + push: + tags: + - solid-oidc-draft-[0-9]+ + +jobs: + publish: + 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 + run: | + mkdir publish + mv index.html ./publish/oidc.html + mv solid.svg ./publish/solid.svg + mv 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 + + mv primer/index.html ./publish/oidc-primer.html + mv primer/primer-login.mmd.svg ./publish/oidc-primer-login.svg + mv 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/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 + + - name: Publish to GitHub pages + uses: peaceiris/actions-gh-pages@v3 + with: + publish_dir: ./publish + publish_branch: solid-tr-publication + personal_token: ${{ secrets.GITHUB_TOKEN }} + From 9af689455903d66e2834a4dad0d2ee6a9f245b94 Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 15:41:00 -0400 Subject: [PATCH 02/10] Add immutable portion --- .github/workflows/publication-config.yml | 40 ++++++++++++++++++------ 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml index 230eea7..c9a209e 100644 --- a/.github/workflows/publication-config.yml +++ b/.github/workflows/publication-config.yml @@ -38,25 +38,45 @@ jobs: 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 - mv index.html ./publish/oidc.html - mv solid.svg ./publish/solid.svg - mv sequence.mmd.svg ./publish/oidc-sequence.svg - sed -i 's/sequence.mmd.svg/oidc-sequence.svg/g' ./publish/oidc.html + 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 - mv primer/index.html ./publish/oidc-primer.html - mv primer/primer-login.mmd.svg ./publish/oidc-primer-login.svg - mv 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 + 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/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 - - name: Publish to GitHub pages + 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/$YEAR/oidc-primer-$DAY|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/$YEAR/oidc-$DAY|g' ./publish/$YEAR/oidc-primer-$DAY.html + + - name: Publish to TR Publication branch uses: peaceiris/actions-gh-pages@v3 with: publish_dir: ./publish From 05b4507e834d9d8261c34a86bd4fc97e371c004e Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 15:42:24 -0400 Subject: [PATCH 03/10] Test workflow -- this commit will be reverted --- .github/workflows/publication-config.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml index c9a209e..3439e03 100644 --- a/.github/workflows/publication-config.yml +++ b/.github/workflows/publication-config.yml @@ -2,6 +2,9 @@ name: Format as CG Draft on: + # Testing -- to be removed + pull_request: + branches: [ main ] push: tags: - solid-oidc-draft-[0-9]+ From 4e1fb81ef62225abf3362950fe044bab712f10e9 Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 15:46:23 -0400 Subject: [PATCH 04/10] Fix date formatting --- .github/workflows/publication-config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml index 3439e03..605491f 100644 --- a/.github/workflows/publication-config.yml +++ b/.github/workflows/publication-config.yml @@ -59,8 +59,8 @@ jobs: 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 - YEAR=(date '+%Y') - DAY=(date '+%Y%m%d') + YEAR=$(date '+%Y') + DAY=$(date '+%Y%m%d') mkdir ./publish/$YEAR cp index.html ./publish/$YEAR/oidc-$DAY.html From b5c66d85ec321f1a9bc7a08c6f92feec92d44623 Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 15:50:55 -0400 Subject: [PATCH 05/10] Better variable interpolation --- .github/workflows/publication-config.yml | 34 ++++++++++++------------ 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml index 605491f..0412ca7 100644 --- a/.github/workflows/publication-config.yml +++ b/.github/workflows/publication-config.yml @@ -46,18 +46,18 @@ jobs: 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 + 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/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 + 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/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 YEAR=$(date '+%Y') DAY=$(date '+%Y%m%d') @@ -65,19 +65,19 @@ jobs: 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/$YEAR/oidc-primer-$DAY|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 + 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/$YEAR/oidc-primer-$DAY|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/$YEAR/oidc-$DAY|g' ./publish/$YEAR/oidc-primer-$DAY.html + 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/$YEAR/oidc-$DAY|g" ./publish/$YEAR/oidc-primer-$DAY.html - name: Publish to TR Publication branch uses: peaceiris/actions-gh-pages@v3 From 9a9444bff73fc34987dc63e7b0f5f2b93ceb1b14 Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 15:59:40 -0400 Subject: [PATCH 06/10] Add comment --- .github/workflows/publication-config.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml index 0412ca7..a907f43 100644 --- a/.github/workflows/publication-config.yml +++ b/.github/workflows/publication-config.yml @@ -10,7 +10,7 @@ on: - solid-oidc-draft-[0-9]+ jobs: - publish: + generate: runs-on: ubuntu-latest steps: - name: Checkout repository @@ -56,9 +56,11 @@ jobs: 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 From 51d95ac37d7305b33e02c3ce67b75bd94d191813 Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 16:04:05 -0400 Subject: [PATCH 07/10] Substitution adjustment --- .github/workflows/publication-config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml index a907f43..df5e2f5 100644 --- a/.github/workflows/publication-config.yml +++ b/.github/workflows/publication-config.yml @@ -69,7 +69,7 @@ jobs: 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/$YEAR/oidc-primer-$DAY|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 @@ -78,8 +78,8 @@ jobs: 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/|https://solidproject.org/TR/oidc|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/$YEAR/oidc-$DAY|g" ./publish/$YEAR/oidc-primer-$DAY.html - name: Publish to TR Publication branch uses: peaceiris/actions-gh-pages@v3 From fd85f03c4a1b80ba2cd92062ad5d425a8f9c1eb2 Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 16:09:29 -0400 Subject: [PATCH 08/10] Adjust substitution sequence --- .github/workflows/publication-config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml index df5e2f5..e77cda1 100644 --- a/.github/workflows/publication-config.yml +++ b/.github/workflows/publication-config.yml @@ -78,8 +78,8 @@ jobs: 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/|https://solidproject.org/TR/oidc|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 From c8915751c458d14f7e5ffbcb52100993be1dd967 Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 16:10:48 -0400 Subject: [PATCH 09/10] Remove commit from testing --- .github/workflows/publication-config.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/publication-config.yml b/.github/workflows/publication-config.yml index e77cda1..acc0b77 100644 --- a/.github/workflows/publication-config.yml +++ b/.github/workflows/publication-config.yml @@ -2,9 +2,6 @@ name: Format as CG Draft on: - # Testing -- to be removed - pull_request: - branches: [ main ] push: tags: - solid-oidc-draft-[0-9]+ From 2168ff2ec7a6afe151a1771cea72b7aa9b547fff Mon Sep 17 00:00:00 2001 From: Aaron Coburn Date: Tue, 29 Mar 2022 16:21:49 -0400 Subject: [PATCH 10/10] Add instructions to README --- ...ication-config.yml => tr-draft-config.yml} | 0 .github/workflows/tr-final-config.yml | 87 +++++++++++++++++++ README.md | 22 +++++ 3 files changed, 109 insertions(+) rename .github/workflows/{publication-config.yml => tr-draft-config.yml} (100%) create mode 100644 .github/workflows/tr-final-config.yml diff --git a/.github/workflows/publication-config.yml b/.github/workflows/tr-draft-config.yml similarity index 100% rename from .github/workflows/publication-config.yml rename to .github/workflows/tr-draft-config.yml diff --git a/.github/workflows/tr-final-config.yml b/.github/workflows/tr-final-config.yml new file mode 100644 index 0000000..32f2ca6 --- /dev/null +++ b/.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 }} + diff --git a/README.md b/README.md index c75960e..96958bc 100644 --- a/README.md +++ b/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.