From 5355b2d641fba1b600ef080465c6c3522edbc128 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 28 Oct 2025 21:56:01 +0000 Subject: [PATCH 1/6] Use official Pages deploy actions This approach requires no gh-pages branch. Signed-off-by: Arthit Suriyawongkul --- .github/workflows/publish.yml | 59 +++++++++++++++++++++-------------- requirements.txt | 2 +- 2 files changed, 37 insertions(+), 24 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index fd47a8f..4449041 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -3,34 +3,47 @@ on: branches: - main workflow_dispatch: {} + +concurrency: + group: mkdocs-deploy-${{ github.ref_name }} + cancel-in-progress: true + permissions: - contents: write + contents: read + pages: write + id-token: write + jobs: - build: + deploy: + name: Build and deploy MkDocs site runs-on: ubuntu-latest - container: python:3 - env: - REF: "main" # source branch/tag release - GH_PAGES_BRANCH: "gh-pages" # target branch (to publish HTML to) - GIT_USER_NAME: "publish-github-actions" # for gh-pages commit - GIT_USER_EMAIL: "publish-github-actions[bot]@users.noreply.github.com" # for gh-pages commit steps: - name: Checkout content - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #v4.1.7 + uses: actions/checkout@v5 with: - ref: ${{ env.REF }} - path: using fetch-depth: 0 - - name: Install pre-requisites for MkDocs - run: pip install -r using/requirements.txt - - name: Set Git identity - working-directory: using + + - name: Set up Python + uses: actions/setup-python@v6 + with: + python-version: '3.13' + cache: 'pip' + + - name: Install dependencies run: | - git config user.name ${{ env.GIT_USER_NAME }} - git config user.email ${{ env.GIT_USER_EMAIL }} - - name: Sync GitHub Pages - working-directory: using - run: git checkout ${{ env.GH_PAGES_BRANCH }} && git pull && git checkout ${{ env.REF }} - - name: Build and deploy docs - working-directory: using - run: mkdocs gh-deploy --clean --verbose --remote-branch ${{ env.GH_PAGES_BRANCH }} + pip install --upgrade pip + pip install -r requirements.txt + + - name: Build MkDocs site + run: mkdocs build --clean + + - name: Configure GitHub Pages + uses: actions/configure-pages@v5 + + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v4 + with: + path: ./site + + - name: Deploy to GitHub Pages + uses: actions/deploy-pages@v4 diff --git a/requirements.txt b/requirements.txt index e97c812..fd872f4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ mkdocs==1.6.1 -mkdocs-material[imaging]==9.5.34 +mkdocs-material[imaging]==9.6.22 From f11582b307ef43908fd0b12019f6b1284338be38 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 28 Oct 2025 22:25:43 +0000 Subject: [PATCH 2/6] Remove outdated tags_file config Signed-off-by: Arthit Suriyawongkul --- docs/{how-to-vex.mc => how-to-vex.md} | 0 mkdocs.yml | 8 +++----- 2 files changed, 3 insertions(+), 5 deletions(-) rename docs/{how-to-vex.mc => how-to-vex.md} (100%) diff --git a/docs/how-to-vex.mc b/docs/how-to-vex.md similarity index 100% rename from docs/how-to-vex.mc rename to docs/how-to-vex.md diff --git a/mkdocs.yml b/mkdocs.yml index 1d2bf4d..ce2d4fd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,10 +1,10 @@ site_name: Using SPDX -site_description: Information on how to use the System Package Data Exchange specification +site_description: Information on how to use the System Package Data Exchange (SPDX) specification site_author: The Linux Foundation and its Contributors. site_url: https://spdx.github.io/using/ # set to the "root" of the site, to be combined with canonical_version repo_url: https://github.com/spdx/using/ edit_uri: "edit/main/docs" # set to an empty string to disable edit links; -copyright: Using SPDX Copyright © 2024, The Linux Foundation and its Contributors. +copyright: Using SPDX Copyright © 2024-2025, The Linux Foundation and its Contributors. use_directory_urls: true theme: name: material @@ -15,8 +15,7 @@ theme: plugins: - search - social -- tags: - tags_file: tags.md +- tags markdown_extensions: - admonition - abbr @@ -45,4 +44,3 @@ nav: - Using SPDX License List short identifiers in source files: license-id-in-source.md - Using SPDX to comply with norms, standards and regulation: comply-with-norms.md - Differences from previous editions: diffs-from-previous-editions.md -- Browse by tags: tags.md From e6baece046c56b1e03ff4168c0b4d2b506805740 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 28 Oct 2025 22:46:09 +0000 Subject: [PATCH 3/6] Add git-revision-date on page Signed-off-by: Arthit Suriyawongkul --- mkdocs.yml | 14 +++++++++++--- requirements.txt | 1 + 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index ce2d4fd..f9371ee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,9 +1,9 @@ site_name: Using SPDX site_description: Information on how to use the System Package Data Exchange (SPDX) specification -site_author: The Linux Foundation and its Contributors. -site_url: https://spdx.github.io/using/ # set to the "root" of the site, to be combined with canonical_version +site_author: The Linux Foundation and its Contributors +site_url: https://spdx.github.io/using/ repo_url: https://github.com/spdx/using/ -edit_uri: "edit/main/docs" # set to an empty string to disable edit links; +edit_uri: "edit/main/docs" # set to an empty string to disable edit links copyright: Using SPDX Copyright © 2024-2025, The Linux Foundation and its Contributors. use_directory_urls: true theme: @@ -12,7 +12,14 @@ theme: logo: images/logo-white.svg features: - content.action.edit + - navigation.instant + - navigation.instant.progress + palette: + - scheme: default + primary: indigo + accent: indigo plugins: +- git-revision-date - search - social - tags @@ -44,3 +51,4 @@ nav: - Using SPDX License List short identifiers in source files: license-id-in-source.md - Using SPDX to comply with norms, standards and regulation: comply-with-norms.md - Differences from previous editions: diffs-from-previous-editions.md +- Browse by tags: tags.md diff --git a/requirements.txt b/requirements.txt index fd872f4..02f0e59 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ mkdocs==1.6.1 +mkdocs-git-revision-date-localized-plugin==1.4.7 mkdocs-material[imaging]==9.6.22 From 54ac28dd5a389f2e9c8d01c2d3a290333afa376a Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 28 Oct 2025 22:52:13 +0000 Subject: [PATCH 4/6] Revert rename how-to-vex.mc Signed-off-by: Arthit Suriyawongkul --- docs/{how-to-vex.md => how-to-vex.mc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{how-to-vex.md => how-to-vex.mc} (100%) diff --git a/docs/how-to-vex.md b/docs/how-to-vex.mc similarity index 100% rename from docs/how-to-vex.md rename to docs/how-to-vex.mc From 8557ff5e81a186d459dc374ccc7a2d6d1f9cbee7 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 28 Oct 2025 22:54:55 +0000 Subject: [PATCH 5/6] Use mkdocs-git-revision-date-localized-plugin Signed-off-by: Arthit Suriyawongkul --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index f9371ee..f3faf89 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,7 +19,7 @@ theme: primary: indigo accent: indigo plugins: -- git-revision-date +- git-revision-date-localized # Use mkdocs-git-revision-date-localized-plugin - search - social - tags From a4dff27984e012fda045946f536f17758acb8b2b Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 28 Oct 2025 23:01:00 +0000 Subject: [PATCH 6/6] Update copyright year in index.md Signed-off-by: Arthit Suriyawongkul --- .github/workflows/publish.yml | 2 +- docs/index.md | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 4449041..dc3a8e2 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -15,7 +15,7 @@ permissions: jobs: deploy: - name: Build and deploy MkDocs site + name: Build and deploy site runs-on: ubuntu-latest steps: - name: Checkout content diff --git a/docs/index.md b/docs/index.md index a8a0df2..59c468f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,9 +5,9 @@ SPDX-License-Identifier: Community-Spec-1.0 # Using SPDX Information on how to use the -[SPDX specification](https://spdx.dev/use/specifications/). +[System Package Data Exchange (SPDX) specification](https://spdx.dev/use/specifications/). -Copyright © 2024, The Linux Foundation and its Contributors. +Copyright © 2024-2025, The Linux Foundation and its Contributors. This work is licensed under the [Community Specification License 1.0](https://spdx.org/licenses/Community-Spec-1.0.html) @@ -15,6 +15,5 @@ This work is licensed under the !!! info - This is not part of the specification. - - Everything on this website is for informative purpose only. + This website is for informational purposes only and + is not part of the SPDX specification.