From b8a5301f2ffdd56f4c007599f96e2e9260b8b838 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Fri, 23 Feb 2024 19:34:32 +0530 Subject: [PATCH 1/3] add github workflow --- .github/workflows/book.yml | 136 +++++++++++++++++++++++++++++++++++++ 1 file changed, 136 insertions(+) create mode 100644 .github/workflows/book.yml diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml new file mode 100644 index 0000000..29f77a5 --- /dev/null +++ b/.github/workflows/book.yml @@ -0,0 +1,136 @@ +# Documentation and mdbook related jobs. +# Reference: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/book.yml + +name: book + +on: + push: + branches: [main] + pull_request: + branches: [main] + merge_group: + +jobs: + # test: + # runs-on: ubuntu-latest + # name: test + # timeout-minutes: 60 + + # steps: + # - uses: actions/checkout@v4 + + # - name: Install mdbook + # run: | + # mkdir mdbook + # curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook + # echo $(pwd)/mdbook >> $GITHUB_PATH + + # - name: Install mdbook-template + # run: | + # mkdir mdbook-template + # curl -sSL https://github.com/sgoudham/mdbook-template/releases/latest/download/mdbook-template-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook-template + # echo $(pwd)/mdbook-template >> $GITHUB_PATH + + # - name: Run tests + # run: mdbook test + + lint: + runs-on: ubuntu-latest + name: lint + timeout-minutes: 60 + + steps: + - uses: actions/checkout@v4 + + - name: Install mdbook-linkcheck + run: | + mkdir mdbook-linkcheck + curl -sSL -o mdbook-linkcheck.zip https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest/download/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip + unzip mdbook-linkcheck.zip -d ./mdbook-linkcheck + chmod +x $(pwd)/mdbook-linkcheck/mdbook-linkcheck + echo $(pwd)/mdbook-linkcheck >> $GITHUB_PATH + + - name: Run linkcheck + run: mdbook-linkcheck --standalone + + build: + runs-on: ubuntu-latest + timeout-minutes: 60 + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@nightly + - name: Install mdbook + run: | + mkdir mdbook + curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook + echo $(pwd)/mdbook >> $GITHUB_PATH + + - name: Install mdbook-template + run: | + mkdir mdbook-template + curl -sSL https://github.com/sgoudham/mdbook-template/releases/latest/download/mdbook-template-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook-template + echo $(pwd)/mdbook-template >> $GITHUB_PATH + + - uses: Swatinem/rust-cache@v2 + with: + cache-on-failure: true + + - name: Build book + run: mdbook build + + # - name: Build docs + # run: cargo docs + # env: + # # Keep in sync with ./ci.yml:jobs.docs + # RUSTDOCFLAGS: + # --cfg docsrs --show-type-layout --generate-link-to-definition --enable-index-page + # -Zunstable-options + + # - name: Move docs to book folder + # run: | + # mv target/doc target/book/docs + + - name: Archive artifact + shell: sh + run: | + chmod -c -R +rX "target/book" | + while read line; do + echo "::warning title=Invalid file permissions automatically fixed::$line" + done + tar \ + --dereference --hard-dereference \ + --directory "target/book" \ + -cvf "$RUNNER_TEMP/artifact.tar" \ + --exclude=.git \ + --exclude=.github \ + . + + - name: Upload artifact + uses: actions/upload-artifact@v3 + with: + name: github-pages + path: ${{ runner.temp }}/artifact.tar + retention-days: 1 + if-no-files-found: error + + deploy: + # Only deploy if a push to main + if: github.ref_name == 'main' && github.event_name == 'push' + runs-on: ubuntu-latest + needs: [lint, build] + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + timeout-minutes: 60 + + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 From 99ae3b9e01c16338f17917111253a0a0e9a6e3b6 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Fri, 23 Feb 2024 19:38:53 +0530 Subject: [PATCH 2/3] book.yml reshuffling --- docs/book.toml => book.toml | 3 ++- {docs/src => book}/SUMMARY.md | 0 {docs/src => book}/installation.md | 0 {docs/src => book}/introduction.md | 0 {docs/src => book}/runmaya.md | 0 5 files changed, 2 insertions(+), 1 deletion(-) rename docs/book.toml => book.toml (66%) rename {docs/src => book}/SUMMARY.md (100%) rename {docs/src => book}/installation.md (100%) rename {docs/src => book}/introduction.md (100%) rename {docs/src => book}/runmaya.md (100%) diff --git a/docs/book.toml b/book.toml similarity index 66% rename from docs/book.toml rename to book.toml index dcb4019..a31074e 100644 --- a/docs/book.toml +++ b/book.toml @@ -2,5 +2,6 @@ authors = ["Abhishek Kumar","Dhruv Bodani"] language = "en" multilingual = false -src = "src" +src = "book" title = "Maya Docs" +description = "A book on all things maya" \ No newline at end of file diff --git a/docs/src/SUMMARY.md b/book/SUMMARY.md similarity index 100% rename from docs/src/SUMMARY.md rename to book/SUMMARY.md diff --git a/docs/src/installation.md b/book/installation.md similarity index 100% rename from docs/src/installation.md rename to book/installation.md diff --git a/docs/src/introduction.md b/book/introduction.md similarity index 100% rename from docs/src/introduction.md rename to book/introduction.md diff --git a/docs/src/runmaya.md b/book/runmaya.md similarity index 100% rename from docs/src/runmaya.md rename to book/runmaya.md From e4dfdb967acd1c9e911be55423c5a85c0761e3e4 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Fri, 23 Feb 2024 22:19:52 +0530 Subject: [PATCH 3/3] some corrections --- book.toml | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/book.toml b/book.toml index a31074e..df2fe5d 100644 --- a/book.toml +++ b/book.toml @@ -4,4 +4,20 @@ language = "en" multilingual = false src = "book" title = "Maya Docs" -description = "A book on all things maya" \ No newline at end of file +description = "A book on all things maya" + +[output.html] +theme = "book/theme" +git-repository-url = "https://github.com/LabsMaya/maya-zk-benchmarks" +default-theme = "ayu" +no-section-label = true + +[output.html.fold] +enable = true +level = 1 + +[output.html.playground] +runnable = false + +[build] +build-dir = "target/book"