Improve landing page and Readme (#50) #42
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
name: Automated Documentation Update | |
on: | |
push: | |
branches: [ "main" ] | |
env: | |
CARGO_TERM_COLOR: always | |
jobs: | |
update-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
ref: 'main' | |
fetch-depth: 0 | |
- name: Configure Git | |
run: | | |
git config --local user.email "docmaster+github-actions[bot]@users.noreply.github.com" | |
git config --local user.name "github-actions[bot]" | |
- name: Prepare | |
run: | | |
cargo doc --document-private-items | |
mkdir docs | |
cp -R target/doc docs/libs | |
rm -R .github | |
- name: Copy Rustc Docs | |
run: | | |
cd doc-src && cargo run | |
- name: Build Index Page | |
uses: docker://pandoc/core | |
with: | |
args: "-s -o docs/index.html doc-src/index.md" | |
- name: Commit Doc Generation | |
run: | | |
git add docs | |
git commit -m 'Generate Documentation' | |
- name: Push Doc Update | |
uses: ad-m/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
branch: 'github-actions-suck' | |
force: true |