Publish 3.0.1 as v3.0.1-draft

.github/workflows/publish_v3.yml

@@ -11,26 +11,28 @@ jobs:
     runs-on: ubuntu-latest
     container: python:3
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  #v4.1.7
         with:
           ref: development/v3.0.1
           path: spdx-spec
-          fetch-depth: 0 # Because we will be pushing the gh-pages branch
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
+          fetch-depth: 0  # Because we will be pushing the gh-pages branch
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  #v4.1.7
         with:
           repository: spdx/spec-parser
           ref: main
           path: spec-parser
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  #v4.1.7
         with:
           repository: spdx/spdx-3-model
-          ref: main
+          ref: main  # for v3.0.1-draft, checkout latest from main (development)
+          # Once 3.0.1 released, use the following ref to checkout from the release tag
+          # ref: 3.0.1  # for v3.0.1 final release
           path: spdx-3-model
-      - name: Install pre-requisites
+      - name: Install pre-requisites for spdx-spec
         run: pip install -r spdx-spec/requirements.txt
       - name: Install pre-requisites for spec-parser
         run: pip install -r spec-parser/requirements.txt
-      - name: Build model
+      - name: Build model files
         run: python3 spec-parser/main.py spdx-3-model/model spdx-spec/docs/model
       - name: Copy JSON annotations
         run: cp spdx-spec/serialization/jsonld/annotations.ttl spdx-spec/docs/model/jsonld-annotations.ttl
@@ -43,11 +45,32 @@ jobs:
             jsonschema \
             --output spdx-spec/docs/model/schema.json
       - name: Set git identity
-        run: git config user.name ci-bot; git config user.email [email protected]
         working-directory: spdx-spec
+        run: git config user.name ci-bot; git config user.email [email protected]
       - name: Sync gh-pages
+        working-directory: spdx-spec
         run: git checkout gh-pages && git pull && git checkout development/v3.0.1
+      - name: Build docs and set aliases
         working-directory: spdx-spec
-      - name: Build docs
-        run: mike deploy v3.0.1 latest -b gh-pages -p
+        run: |
+          MODEL_YML="docs/model/mkdocs-files.yml"
+          BASE_MKDOCS_YML="mkdocs.yml"
+          FINAL_MKDOCS_YML="mkdocs-final.yml"
+          echo "Build $FINAL_MKDOCS_YML from $BASE_MKDOCS_YML and $MODEL_YML"
+          sed -e "\|- model.*#.*[MODEL_PLACEHOLDER].*|{
+              r $MODEL_YML
+              a\\
+
+              d
+          }" "$BASE_MKDOCS_YML" > "$FINAL_MKDOCS_YML"
+          echo "====================="
+          echo "Start mike deploy"
+          echo "====================="
+          mike deploy --update-aliase --config-file "$FINAL_MKDOCS_YML" --branch gh-pages --push v3.0.1-draft
+        # Once 3.0.1 released, use the following command to deploy 3.0.1 as latest version
+        # mike deploy --update-aliase --config-file "$FINAL_MKDOCS_YML" --branch gh-pages --push v3.0.1 latest
+      - name: Set default version
         working-directory: spdx-spec
+        run: mike set-default v3.0
+        # Once 3.0.1 released, use the following command to set 3.0.1 as default version
+        # run: mike set-default v3.0.1

.github/workflows/validate_pull_request.yml

@@ -6,10 +6,44 @@ jobs:
     runs-on: ubuntu-latest
     container: python:3
     steps:
-    - uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
-    - name: Install pre-requisites
-      run: pip install -r requirements.txt
-    - name: Build
-      run: mkdocs build -v --clean
+      - name: Checkout spdx-spec
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  #v4.1.7
+        with:
+          path: spdx-spec
+          fetch-depth: 1
+      - name: Checkout spdx-3-model
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  #v4.1.7
+        with:
+          repository: spdx/spdx-3-model
+          ref: main
+          path: spdx-3-model
+      - name: Checkout spec-parser
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  #v4.1.7
+        with:
+          repository: spdx/spec-parser
+          ref: main
+          path: spec-parser
+      - name: Install pre-requisites for spdx-spec
+        run: pip install -r spdx-spec/requirements.txt
+      - name: Install pre-requisites for spec-parser
+        run: pip install -r spec-parser/requirements.txt
+      - name: Build model files
+        run: python3 spec-parser/main.py spdx-3-model/model spdx-spec/docs/model
+      - name: Build the site to validate
+        working-directory: spdx-spec
+        run: |
+          MODEL_YML="docs/model/mkdocs-files.yml"
+          BASE_MKDOCS_YML="mkdocs.yml"
+          FINAL_MKDOCS_YML="mkdocs-final.yml"
+          echo "Build $FINAL_MKDOCS_YML from $BASE_MKDOCS_YML and $MODEL_YML"
+          sed -e "\|- model.*#.*[MODEL_PLACEHOLDER].*|{
+              r $MODEL_YML
+              a\\
+
+              d
+          }" "$BASE_MKDOCS_YML" > "$FINAL_MKDOCS_YML"
+          echo "====================="
+          echo "Start mkdocs build"
+          echo "====================="
+          ENABLE_PDF_EXPORT=0 mkdocs build --clean --config-file "$FINAL_MKDOCS_YML" --verbose
+        # Build without the time-consuming PDF export