feat(docs): Publish PDF of protocol specs + remove links to pages in item lists in protocol specs #6684
There are no files selected for viewing
This file contains 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 |
|---|---|---|
|
|
@@ -29,3 +29,42 @@ jobs: | |
|
|
||
| - timeout-minutes: 25 | ||
| run: earthly-ci --no-output ./docs/+deploy-prod --NETLIFY_AUTH_TOKEN=${{ secrets.NETLIFY_AUTH_TOKEN }} --NETLIFY_SITE_ID=${{ secrets.NETLIFY_SITE_ID }} --COMMIT_TAG=${{ inputs.tag }} | ||
|
|
||
| pdf: | ||
| needs: setup | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| token: ${{ secrets.AZTEC_BOT_GITHUB_TOKEN }} | ||
| path: aztec-packages | ||
| - name: Checkout tools repo | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| token: ${{ secrets.AZTEC_BOT_GITHUB_TOKEN }} | ||
| repository: AztecProtocol/protocol-specs-pdf | ||
| path: protocol-specs-pdf | ||
| - name: Install Prince | ||
| run: | | ||
| curl https://www.princexml.com/download/prince-14.2-linux-generic-x86_64.tar.gz -O | ||
| tar zxf prince-14.2-linux-generic-x86_64.tar.gz | ||
| cd prince-14.2-linux-generic-x86_64 | ||
| yes "" | sudo ./install.sh | ||
| - name: generate pdf | ||
| run: | | ||
| cd aztec-packages/docs | ||
| yarn serve | ||
|
There was a problem hiding this comment. I believe the docs are built earlier, how can I access the build so I don't need to build them again and can just serve them? Will it work to serve them locally in Earthly, or should I try to grab the pages from the published url above? |
||
| # add generated pdf to the protocol-specs-pdf repo cloned above | ||
| npx docusaurus-prince-pdf -u http://localhost:3000/protocol-specs/intro --output ../../protocol-specs-pdf/protocol-specs.pdf | ||
| timeout-minutes: 4 | ||
| - name: push to pdf repo | ||
| run: | | ||
| git config --global user.name AztecBot | ||
| git config --global user.email [email protected] | ||
| cd protocol-specs-pdf | ||
| git add protocol-specs.pdf | ||
| git commit -m "chore: update protocol-specs.pdf" | ||
| git push | ||
|
|
||
This file contains 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do I need to check out this repo again, since it was done above?