Skip to content
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.

Sign up for GitHub

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

build: deploy docs site on github pages #58

Merged
merged 2 commits into from
Mar 26, 2024
+57 −0
Merged

build: deploy docs site on github pages #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd224a7
build: deploy docs site on github pages
lklimek Mar 20, 2024
6d5fb72
chore: gh pages only on push to master
lklimek Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/github-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Github Pages

on:
push:
branches:
- master
- "build/docs-website" # TODO remove after it's merged
jobs:
cleanup-runs:
runs-on: ubuntu-latest
steps:
- uses: rokroskar/workflow-run-cleanup-action@master
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/master'"

gh-pages:
# environment:
# name: github-pages
# url: ${{ steps.deployment.outputs.page_url }}
permissions:
contents: read
pages: write
id-token: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- uses: ./.github/actions/deps

- name: Setup Pages
uses: actions/configure-pages@v3

- name: Generate documentation
shell: bash
env:
RUSTDOCFLAGS: "--cfg docsrs"
run: cargo doc --no-deps --all-features --workspace --exclude tenderdash-proto-compiler

- name: Generate index page
shell: bash
run: |
cat > target/doc/index.html << EOF
<html><head><meta http-equiv="refresh" content="0; url=tenderdash_abci/" /></head>
<body><a href="tenderdash_abci/">Click here</a></body>
</html>
EOF

- name: Upload docs
uses: actions/upload-pages-artifact@v1
with:
path: "target/doc"

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
Loading