-
Notifications
You must be signed in to change notification settings - Fork 615
chore(docs): docs versioning #13424
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+193
−288
Merged
chore(docs): docs versioning #13424
Changes from 34 commits
Commits
Show all changes
38 commits
Select commit
Hold shift + click to select a range
aa7a7b4
chore(docs): splitting docs versioning
signorecello ebe13e7
chore(docs): making docs versioning manual, but building them on master
signorecello 67ce9bb
chore(docs): making docs versioning manual, but building them on master
signorecello 22ac435
chore(docs): making docs versioning manual, but building them on master
signorecello 16aba78
cleanup
signorecello a2c0499
bug
signorecello 01d9d3d
more cleanup
signorecello b341d43
adding instructions to the README
signorecello 43bf43e
making next version be called next, for now
signorecello 3beffcc
releasing alpha-testnet.2 docs here because of broken links in master
signorecello 6528e27
restoring builds on builds
signorecello de62282
wip
signorecello 402b626
wip
signorecello 5841b72
wip
signorecello 647e546
wip
signorecello 8fdc305
restoring paths
signorecello 1614e93
wip
signorecello e2c3fec
wip
signorecello b4cbedf
some cleanup
signorecello cb9200b
removing dangling release-please action
signorecello f32eb5b
bug
signorecello b13a58e
inverting the deploy logic to account for empty dist tag
signorecello 26eb377
different strategy using github actions
signorecello 34c2e04
docs: update utility fn docs (#13310)
nventuro 6a649a2
chore: replace relative paths to noir-protocol-circuits
c3c80aa
git_subrepo.sh: Fix parent in .gitrepo file.
6e62263
git subrepo push --branch=master noir-projects/aztec-nr
e45139b
fix(avm): request paths for appendLeaves (#13389)
fcarreiro dcd79c3
feat(avm): tree padding (#13394)
fcarreiro 55439a7
wip
signorecello 9c93c0b
wip
signorecello c21ba94
Merge remote-tracking branch 'origin' into zkpedro/docs_vers
signorecello b6ec048
wip
signorecello 2bbcc95
cleanup
signorecello 9edda1e
applying suggestions
signorecello 21c1bc8
Update .github/workflows/docs-deploy.yml
signorecello 98803ff
updating readme
signorecello 22afe9a
filtering versions.json
signorecello File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| name: Docs Deploy | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - master | ||
|
|
||
| jobs: | ||
| docs-pr: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | ||
| AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} | ||
| NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Set up Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: "18" | ||
|
|
||
| - name: Enable Corepack | ||
| run: corepack enable | ||
|
|
||
| - name: Generate directory hashes | ||
| id: dir-hashes | ||
| run: | | ||
| echo "noir_hash=$(./noir/bootstrap.sh hash)" >> $GITHUB_OUTPUT | ||
| echo "barretenberg_hash=$(./barretenberg/bootstrap.sh hash)" >> $GITHUB_OUTPUT | ||
| echo "l1_contracts_hash=$(./l1-contracts/bootstrap.sh hash)" >> $GITHUB_OUTPUT | ||
| echo "yarn_project_hash=$(./yarn-project/bootstrap.sh hash)" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Restore Noir cache | ||
| id: cache-noir | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ./noir | ||
| key: noir-build-${{ runner.os }}-${{ steps.dir-hashes.outputs.noir_hash }} | ||
| restore-keys: | | ||
| noir-build-${{ runner.os }}-${{ steps.dir-hashes.outputs.noir_hash }} | ||
|
|
||
| - name: Restore Barretenberg cache | ||
| id: cache-barretenberg | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ./barretenberg | ||
| key: barretenberg-build-${{ runner.os }}-${{ steps.dir-hashes.outputs.barretenberg_hash }} | ||
| restore-keys: | | ||
| barretenberg-build-${{ runner.os }}-${{ steps.dir-hashes.outputs.barretenberg_hash }} | ||
|
|
||
| - name: Restore L1 contracts cache | ||
| id: cache-l1-contracts | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ./l1-contracts | ||
| key: l1-contracts-${{ runner.os }}-${{ steps.dir-hashes.outputs.l1_contracts_hash }} | ||
| restore-keys: | | ||
| l1-contracts-${{ runner.os }}-${{ steps.dir-hashes.outputs.l1_contracts_hash }} | ||
|
|
||
| - name: Restore Yarn project cache | ||
| id: cache-yarn-project | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ./yarn-project | ||
| key: yarn-project-${{ runner.os }}-${{ steps.dir-hashes.outputs.yarn_project_hash }} | ||
| restore-keys: | | ||
| yarn-project-${{ runner.os }}-${{ steps.dir-hashes.outputs.yarn_project_hash }} | ||
|
|
||
| - name: Build dependencies | ||
| run: | | ||
| if [[ "${{ steps.cache-noir.outputs.cache-hit }}" != 'true' ]]; then | ||
| echo "Building Noir (cache miss)" | ||
| ./noir/bootstrap.sh fast | ||
| fi | ||
| if [[ "${{ steps.cache-barretenberg.outputs.cache-hit }}" != 'true' ]]; then | ||
| echo "Building Barretenberg (cache miss)" | ||
| ./barretenberg/bootstrap.sh fast | ||
| fi | ||
| if [[ "${{ steps.cache-l1-contracts.outputs.cache-hit }}" != 'true' ]]; then | ||
| echo "Building L1 contracts (cache miss)" | ||
| ./l1-contracts/bootstrap.sh fast | ||
| fi | ||
| if [[ "${{ steps.cache-yarn-project.outputs.cache-hit }}" != 'true' ]]; then | ||
| echo "Building Yarn project (cache miss)" | ||
| ./yarn-project/bootstrap.sh fast | ||
| fi | ||
|
|
||
| - name: Deploy docs | ||
| working-directory: ./docs | ||
| run: | | ||
| echo "docs release preview" | ||
|
signorecello marked this conversation as resolved.
Outdated
|
||
| yarn install | ||
| yarn build | ||
|
|
||
| if ! deploy_output=$(yarn netlify deploy --site aztec-docs-dev --prod 2>&1); then | ||
| echo "Netlify deploy failed with error:" | ||
| echo "$deploy_output" | ||
| exit 1 | ||
| fi | ||
|
signorecello marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| name: Docs Preview | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review, labeled] | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| issues: write | ||
|
|
||
| jobs: | ||
| docs-preview: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | ||
| AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} | ||
| NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Set up Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: "18" | ||
|
|
||
| - name: Enable Corepack | ||
| run: corepack enable | ||
|
|
||
| - name: Configure Git | ||
| run: | | ||
| git config --global user.name AztecBot | ||
| git config --global user.email tech@aztecprotocol.com | ||
|
|
||
| - name: Generate directory hashes | ||
| id: dir-hashes | ||
| run: | | ||
| echo "noir_hash=$(./noir/bootstrap.sh hash)" >> $GITHUB_OUTPUT | ||
| echo "barretenberg_hash=$(./barretenberg/bootstrap.sh hash)" >> $GITHUB_OUTPUT | ||
| echo "l1_contracts_hash=$(./l1-contracts/bootstrap.sh hash)" >> $GITHUB_OUTPUT | ||
| echo "yarn_project_hash=$(./yarn-project/bootstrap.sh hash)" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Restore Noir cache | ||
| id: cache-noir | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ./noir | ||
| key: noir-build-${{ runner.os }}-${{ steps.dir-hashes.outputs.noir_hash }} | ||
| restore-keys: | | ||
| noir-build-${{ runner.os }}-${{ steps.dir-hashes.outputs.noir_hash }} | ||
|
|
||
| - name: Restore Barretenberg cache | ||
| id: cache-barretenberg | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ./barretenberg | ||
| key: barretenberg-build-${{ runner.os }}-${{ steps.dir-hashes.outputs.barretenberg_hash }} | ||
| restore-keys: | | ||
| barretenberg-build-${{ runner.os }}-${{ steps.dir-hashes.outputs.barretenberg_hash }} | ||
|
|
||
| - name: Restore L1 contracts cache | ||
| id: cache-l1-contracts | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ./l1-contracts | ||
| key: l1-contracts-${{ runner.os }}-${{ steps.dir-hashes.outputs.l1_contracts_hash }} | ||
| restore-keys: | | ||
| l1-contracts-${{ runner.os }}-${{ steps.dir-hashes.outputs.l1_contracts_hash }} | ||
|
|
||
| - name: Restore Yarn project cache | ||
| id: cache-yarn-project | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ./yarn-project | ||
| key: yarn-project-${{ runner.os }}-${{ steps.dir-hashes.outputs.yarn_project_hash }} | ||
| restore-keys: | | ||
| yarn-project-${{ runner.os }}-${{ steps.dir-hashes.outputs.yarn_project_hash }} | ||
|
|
||
| - name: Build dependencies | ||
| run: | | ||
| if [[ "${{ steps.cache-noir.outputs.cache-hit }}" != 'true' ]]; then | ||
| echo "Building Noir (cache miss)" | ||
| ./noir/bootstrap.sh fast | ||
| fi | ||
| if [[ "${{ steps.cache-barretenberg.outputs.cache-hit }}" != 'true' ]]; then | ||
| echo "Building Barretenberg (cache miss)" | ||
| ./barretenberg/bootstrap.sh fast | ||
| fi | ||
| if [[ "${{ steps.cache-l1-contracts.outputs.cache-hit }}" != 'true' ]]; then | ||
| echo "Building L1 contracts (cache miss)" | ||
| ./l1-contracts/bootstrap.sh fast | ||
| fi | ||
| if [[ "${{ steps.cache-yarn-project.outputs.cache-hit }}" != 'true' ]]; then | ||
| echo "Building Yarn project (cache miss)" | ||
| ./yarn-project/bootstrap.sh fast | ||
| fi | ||
|
|
||
| - name: Run release-preview script | ||
| working-directory: ./docs | ||
| run: | | ||
| echo "docs release preview" | ||
| yarn install | ||
| yarn build | ||
|
|
||
| if ! deploy_output=$(yarn netlify deploy --site aztec-docs-dev 2>&1); then | ||
| echo "Netlify deploy failed with error:" | ||
| echo "$deploy_output" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Extract preview URL. | ||
| docs_preview_url=$(echo "$deploy_output" | grep -E "https://.*aztec-docs-dev.netlify.app" | awk '{print $4}') | ||
| if [ -z "$docs_preview_url" ]; then | ||
| echo "Failed to extract preview URL from Netlify output." | ||
| else | ||
| echo "Docs preview URL: ${docs_preview_url}" | ||
| echo "docs_preview_url=${docs_preview_url}" >> $GITHUB_ENV | ||
| fi | ||
|
|
||
| - name: Find Comment | ||
| uses: peter-evans/find-comment@v2 | ||
| id: find-comment | ||
| if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository | ||
| with: | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| comment-author: "github-actions[bot]" | ||
| body-includes: "<!-- AUTOGENERATED DOCS COMMENT -->" | ||
|
|
||
| - name: Create or Update Comment | ||
| uses: peter-evans/create-or-update-comment@v3 | ||
| if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository | ||
| with: | ||
| comment-id: ${{ steps.find-comment.outputs.comment-id }} | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| body: | | ||
| # Docs Preview | ||
| You can check your [preview here](${{ env.docs_preview_url }}). | ||
|
|
||
| <!-- AUTOGENERATED DOCS COMMENT --> | ||
| edit-mode: replace |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.