From c95d4e3679e28b67b67df82b0b15ad1b8685bd01 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Tue, 15 Nov 2022 15:25:52 +0100 Subject: [PATCH 1/7] Add docs building CI --- .github/workflows/docs.yml | 44 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000000..e482f2f0979 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,44 @@ +name: Build and host documentation +on: + push: + branches: + - master + - host-master-docs + +jobs: + build: + name: Build documentation + runs-on: ubuntu-latest + steps: + - name: Install Protoc + uses: arduino/setup-protoc@v1 + - name: Checkout + uses: actions/checkout@v3 + - name: Build Documentation + run: carto doc --no-deps --workspace -F full + - name: Add index file + run: | + mkdir host-docs + echo "" > target/doc/index.html + cp -r target/doc ./host-docs + - name: Upload documentation + uses: actions/upload-pages-artifacts@v1.0.4 + with: + path: "host-docs/" + + deploy: + name: Deploy documentation + needs: build + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 + From f23afb9cce5cacbc38aa2e9bf953f3b8c19c81a5 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Tue, 15 Nov 2022 15:27:42 +0100 Subject: [PATCH 2/7] Correct CI --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e482f2f0979..f17f7452917 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,7 +22,7 @@ jobs: echo "" > target/doc/index.html cp -r target/doc ./host-docs - name: Upload documentation - uses: actions/upload-pages-artifacts@v1.0.4 + uses: actions/upload-pages-artifact@v1.0.4 with: path: "host-docs/" From f913ae5b56e80ddbbba3bbb8c442ce31221a54bc Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Tue, 15 Nov 2022 15:29:39 +0100 Subject: [PATCH 3/7] corrected typos --- .github/workflows/docs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f17f7452917..1f79ac5608f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,7 +15,10 @@ jobs: - name: Checkout uses: actions/checkout@v3 - name: Build Documentation - run: carto doc --no-deps --workspace -F full + run: cargo +nightly doc --no-deps --workspace -F full + env: + RUSTDOCFLAGS: "-C docsrs" + RUSTFLAGS: "-C docsrs" - name: Add index file run: | mkdir host-docs From fe999333183768b8abdccf0684bd728174e06aa2 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Tue, 15 Nov 2022 15:31:04 +0100 Subject: [PATCH 4/7] Add install of nightly toolchain --- .github/workflows/docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1f79ac5608f..0dc17012e9e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,6 +14,8 @@ jobs: uses: arduino/setup-protoc@v1 - name: Checkout uses: actions/checkout@v3 + - name: Install nightly toolchain + run: rustup toolchain install nightly - name: Build Documentation run: cargo +nightly doc --no-deps --workspace -F full env: From 2ab4b8f7caf26b773ed0288f2de0a481e2321f83 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Tue, 15 Nov 2022 15:31:59 +0100 Subject: [PATCH 5/7] Add correct cfg --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0dc17012e9e..00975bb6d40 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,8 +19,8 @@ jobs: - name: Build Documentation run: cargo +nightly doc --no-deps --workspace -F full env: - RUSTDOCFLAGS: "-C docsrs" - RUSTFLAGS: "-C docsrs" + RUSTDOCFLAGS: "--cfg docsrs" + RUSTFLAGS: "--cfg docsrs" - name: Add index file run: | mkdir host-docs From a450c93531b583fe29b16e8a28059ca8dc7fbf34 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Tue, 15 Nov 2022 15:43:08 +0100 Subject: [PATCH 6/7] Correctd CI to run --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 00975bb6d40..c4421ae4fa5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,7 +25,7 @@ jobs: run: | mkdir host-docs echo "" > target/doc/index.html - cp -r target/doc ./host-docs + cp -r target/doc/* ./host-docs - name: Upload documentation uses: actions/upload-pages-artifact@v1.0.4 with: From 2490d8c8490bbc4c0ed6bb0222409abeed21b7b6 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Tue, 15 Nov 2022 15:51:14 +0100 Subject: [PATCH 7/7] Remove teh exception --- .github/workflows/docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c4421ae4fa5..593d4e866d3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,7 +3,6 @@ on: push: branches: - master - - host-master-docs jobs: build: