mdbook deployment integration #215
Conversation
|
Can you show some screenshots of the resulting page? |
|
|
.github/workflows/deploy.yml
Outdated
| - name: Deploy GitHub Pages | ||
| run: | | ||
| mdbook build | ||
| git worktree add gh-pages | ||
| git config user.name "Deploy from CI" | ||
| git config user.email "" | ||
| cd gh-pages | ||
| # Delete the ref to avoid keeping history. | ||
| git update-ref -d refs/heads/gh-pages | ||
| rm -rf * | ||
| mv ../book/* . | ||
| git add . | ||
| git commit -m "Deploy $GITHUB_SHA to gh-pages" | ||
| git push --force --set-upstream origin gh-pages |
There was a problem hiding this comment.
Can we use https://github.com/actions/upload-pages-artifact & https://github.com/actions/deploy-pages instead of this?
There was a problem hiding this comment.
Thanks for the feedback @elopez the deployment script has been updated, now using the above recommended actions.
Co-authored-by: Emilio López <2642849+elopez@users.noreply.github.com>
Co-authored-by: Emilio López <2642849+elopez@users.noreply.github.com>
Co-authored-by: Emilio López <2642849+elopez@users.noreply.github.com>
.github/workflows/deploy.yml
Outdated
| @@ -0,0 +1,40 @@ | |||
| name: Deploy | |||
There was a problem hiding this comment.
Maybe Deploy GH page. Otherwise if might collide with future gh worklow
| @@ -0,0 +1,116 @@ | |||
| # Summary | |||
There was a problem hiding this comment.
Was this file generated automatically, or should we note in our process that we need to update it every time?
There was a problem hiding this comment.
Nope, we'd need to manually update SUMMARY.md whenever new .md files are added, we'd need to add that to the contribution guidelines
This PR fixes issue #206 using mdbook to make a nicer UX to navigate building secure contracts