From ba68e0ee6cfb514ac4051d9a5a73a1c4b32abe95 Mon Sep 17 00:00:00 2001 From: Paul-Nicolas Madelaine Date: Tue, 5 Dec 2023 06:43:03 +0100 Subject: [PATCH 1/5] CI: fix documentation (#435) * ci: build static content on pull requests * ci: update `setup-rust-action` when building static content * ci: build documentation on macos --- .github/workflows/gh-pages.yml | 54 +++++++++++++++++----------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 8396545c..51a23ad5 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -1,29 +1,16 @@ -name: Deploy static content to GitHub Pages +name: Build & Deploy static content to GitHub Pages on: push: branches: ["main"] + pull_request: workflow_dispatch: -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write - -# Allow one concurrent deployment -concurrency: - group: "pages" - cancel-in-progress: true - jobs: - # Single deploy job since we're just deploying - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-22.04 + build: + # build on macos until bindgen is fixed + runs-on: macos-latest steps: - name: Checkout uses: actions/checkout@v3 @@ -34,20 +21,17 @@ jobs: run: git fetch --tags origin - name: Setup | mdBook | 1/2 - uses: hecrj/setup-rust-action@8708beccd22540a3f955ae10cc884af27ca81bf5 + uses: hecrj/setup-rust-action@f344d1a51e8ad6e1c6c51d9cf8d5a6edf4cfd230 - name: Setup | mdBook | 2/2 uses: peaceiris/actions-mdbook@4b5ef36b314c2599664ca107bb8c02412548d79d with: mdbook-version: "latest" - - name: Setup | Update - run: sudo apt-get update - - name: Setup | System run: | - sudo apt-get install doxygen python3-sphinx libgmp-dev ninja-build nodejs - sudo pip install --upgrade pip + brew install doxygen sphinx-doc gmp ninja node + pip install --upgrade pip - name: Setup | OCaml | 1/2 uses: ocaml/setup-ocaml@v2 @@ -67,9 +51,6 @@ jobs: cd docs/reference pip install -r requirements.txt - - name: Setup | Pages - uses: actions/configure-pages@v2 - - name: Build | Book run: | # We `cd` into this directory first because the book @@ -144,6 +125,25 @@ jobs: with: path: "build" + deploy: + if: ${{ github.ref == 'refs/heads/main' }} + needs: build + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-22.04 + # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages + permissions: + contents: read + pages: write + id-token: write + # Allow one concurrent deployment + concurrency: + group: "pages" + cancel-in-progress: true + steps: + - name: Setup | Pages + uses: actions/configure-pages@v2 - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v1 From 3f68154767fdad45016059a09f1d4f1b87c9d717 Mon Sep 17 00:00:00 2001 From: Franziskus Kiefer Date: Wed, 6 Dec 2023 14:41:14 +0100 Subject: [PATCH 2/5] Add xvzcf to .clabot --- .clabot | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.clabot b/.clabot index a049f5a8..c955ab75 100644 --- a/.clabot +++ b/.clabot @@ -11,7 +11,8 @@ "mamonet": "", "emillon": "", "protz": "", - "ma-ilsi": "" + "ma-ilsi": "", + "xvzcf": "Cryspen" }, "contributors": [ "franziskuskiefer", @@ -25,6 +26,7 @@ "mamonet", "emillon", "protz", - "ma-ilsi" + "ma-ilsi", + "xvzcf" ] } From 2d91914f5a40ce96263501868167ff87532f14a0 Mon Sep 17 00:00:00 2001 From: Paul-Nicolas Madelaine Date: Tue, 12 Dec 2023 17:12:43 +0100 Subject: [PATCH 3/5] ci: ensure python >=3 is installed (#441) --- .github/workflows/gh-pages.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 51a23ad5..8f023e77 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -46,6 +46,11 @@ jobs: run: | npm install -g jsdoc + - name: Setup | Python + uses: actions/setup-python@v5 + with: + python-version: '3.12' + - name: Setup | Sphinx run: | cd docs/reference From b9998466f7138d6928e8b6b256392a063b823b1c Mon Sep 17 00:00:00 2001 From: Franziskus Kiefer Date: Fri, 5 Jan 2024 11:54:17 +0100 Subject: [PATCH 4/5] Add msprotz to cla --- .clabot | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.clabot b/.clabot index c955ab75..3bba90cb 100644 --- a/.clabot +++ b/.clabot @@ -12,7 +12,8 @@ "emillon": "", "protz": "", "ma-ilsi": "", - "xvzcf": "Cryspen" + "xvzcf": "Cryspen", + "msprotz": "Microsoft" }, "contributors": [ "franziskuskiefer", @@ -27,6 +28,7 @@ "emillon", "protz", "ma-ilsi", - "xvzcf" + "xvzcf", + "msprotz" ] } From 609d0fd4954f5d9140abea779699c4d2f4466a71 Mon Sep 17 00:00:00 2001 From: Franziskus Kiefer Date: Tue, 18 Jun 2024 14:11:02 +0200 Subject: [PATCH 5/5] Update .clabot --- .clabot | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.clabot b/.clabot index 3bba90cb..2b96339d 100644 --- a/.clabot +++ b/.clabot @@ -13,7 +13,9 @@ "protz": "", "ma-ilsi": "", "xvzcf": "Cryspen", - "msprotz": "Microsoft" + "msprotz": "Microsoft", + "R1kM": "Inria", + "samuel-lee-msft": "Microsoft }, "contributors": [ "franziskuskiefer", @@ -29,6 +31,8 @@ "protz", "ma-ilsi", "xvzcf", - "msprotz" + "msprotz", + "R1kM", + "samuel-lee-msft" ] }