From dd62af0c405415bc34e84b66aa923e0d3b1fd326 Mon Sep 17 00:00:00 2001 From: elf Pavlik Date: Sat, 22 Jun 2024 10:50:49 -0600 Subject: [PATCH] update bikeshed setup --- .../{publish-proposals.yml => cd-config.yml} | 7 +--- .github/workflows/ci-config.yml | 37 +++++++++++++++++++ proposals/primer/application.bs | 8 ++-- proposals/primer/authorization-agent.bs | 7 ++-- proposals/primer/logo.include | 3 -- proposals/specification/index.bs | 11 ++---- 6 files changed, 51 insertions(+), 22 deletions(-) rename .github/workflows/{publish-proposals.yml => cd-config.yml} (89%) create mode 100644 .github/workflows/ci-config.yml delete mode 100644 proposals/primer/logo.include diff --git a/.github/workflows/publish-proposals.yml b/.github/workflows/cd-config.yml similarity index 89% rename from .github/workflows/publish-proposals.yml rename to .github/workflows/cd-config.yml index c44cf3aa..e98f9b6a 100644 --- a/.github/workflows/publish-proposals.yml +++ b/.github/workflows/cd-config.yml @@ -19,14 +19,11 @@ jobs: - name: setup python uses: actions/setup-python@v2 with: - python-version: '3.8' - - - name: upgrade pip - run: python3 -m pip install --upgrade pip + python-version: '3.10' - name: install bikeshed run: | - python3 -m pip install --upgrade bikeshed + pipx install bikeshed bikeshed update - name: run bikeshed diff --git a/.github/workflows/ci-config.yml b/.github/workflows/ci-config.yml new file mode 100644 index 00000000..19386d62 --- /dev/null +++ b/.github/workflows/ci-config.yml @@ -0,0 +1,37 @@ +# Workflow for verifying bikeshed documents processing + +name: Verify processing +on: + # only concerned with gating PRs to the main branch + pull_request: + branches: [ main ] + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: checkout + uses: actions/checkout@v2.2.0 + + - name: setup python + uses: actions/setup-python@v2 + with: + python-version: '3.10' + + - name: install bikeshed + run: | + pipx install bikeshed + bikeshed update + + - name: run bikeshed + run: | + bikeshed spec proposals/specification/index.bs + bikeshed spec proposals/primer/application.bs + bikeshed spec proposals/primer/authorization-agent.bs + + - name: generate svg + run: for diagram in proposals/*/diagrams/*.seq.mmd; do docker run --rm -v "$PWD:/data" minlag/mermaid-cli -i /data/$diagram; done + + - name: generate png + run: for diagram in proposals/*/diagrams/*.flow.mmd; do docker run --rm -v "$PWD:/data" minlag/mermaid-cli -i /data/$diagram -o /data/$diagram.png; done diff --git a/proposals/primer/application.bs b/proposals/primer/application.bs index e41b16bd..4c6749dd 100644 --- a/proposals/primer/application.bs +++ b/proposals/primer/application.bs @@ -1,16 +1,16 @@
 Title: Solid Application Interoperability - Application Primer
-Shortname: solid-interop-application-primer
+Shortname: sai-application-primer
 Level: 1
-Status: w3c/UD
-Group: solid-cg
+Status: CG-DRAFT
+Group: solidcg
 URL: https://solid.github.io/data-interoperability-panel/primer/applications.html
 Repository: https://github.com/solid/data-interoperability-panel
 Inline Github Issues: title
 Boilerplate: issues-index no
-Local Boilerplate: logo yes
 Markup Shorthands: markdown yes
 Editor: elf Pavlik
+!Version: 0.1
 Abstract: Primer for libraries intended to be used by applications.
 Boilerplate: omit conformance, omit abstract
 
diff --git a/proposals/primer/authorization-agent.bs b/proposals/primer/authorization-agent.bs index 30742dd6..2da04cca 100644 --- a/proposals/primer/authorization-agent.bs +++ b/proposals/primer/authorization-agent.bs @@ -1,10 +1,10 @@
 Title: Solid Application Interoperability - Authorization Agent Primer
-Shortname: solid-interop-authorization-agent-primer
+Shortname: sai-authorization-agent-primer
 Level: 1
-Status: w3c/UD
-Group: solid-cg
+Status: CG-DRAFT
+Group: solidcg
 URL: https://solid.github.io/data-interoperability-panel/primer/authorization-agent.html
 Repository: https://github.com/solid/data-interoperability-panel
 Inline Github Issues: title
@@ -12,6 +12,7 @@ Boilerplate: issues-index no
 Local Boilerplate: logo yes
 Markup Shorthands: markdown yes
 Editor: elf Pavlik
+!Version: 0.1
 Abstract: Primer for libraries intended to be used by authorization agents.
 Boilerplate: omit conformance, omit abstract
 
diff --git a/proposals/primer/logo.include b/proposals/primer/logo.include deleted file mode 100644 index c11163e0..00000000 --- a/proposals/primer/logo.include +++ /dev/null @@ -1,3 +0,0 @@ - diff --git a/proposals/specification/index.bs b/proposals/specification/index.bs index 0af4a4bf..2a2f29a4 100644 --- a/proposals/specification/index.bs +++ b/proposals/specification/index.bs @@ -1,16 +1,17 @@
 Title: Solid Application Interoperability
-Shortname: interop
+Shortname: sai
 Level: 1
 Max ToC Depth: 2
-Status: w3c/CG-DRAFT
-Group: w3c
+Status: CG-DRAFT
+Group: solidcg
 URL: https://solid.github.io/data-interoperability-panel/specification/
 Repository: https://github.com/solid/data-interoperability-panel
 Inline Github Issues: title
 Editor: Justin Bingham
 Editor: Eric Prud'hommeaux
 Editor: elf Pavlik
+!Version: 0.1
 Markup Shorthands: markdown yes
 Boilerplate: conformance no
 Dark Mode: off
@@ -151,10 +152,6 @@ em.rfc2119 {
 
 
 
-
-MIT License Copyright 2019 - 2021 W3C Solid Community Group -
-
path: introduction.bs
path: agent.bs
path: social-agent.bs