xref: /libCEED/.github/workflows/rust-documentation.yml (revision 8a4ce0d78b95fffc485d7f6e76eabd31204930a1)
1*8a4ce0d7SJeremy L Thompsonname: Rust Documentation
2*8a4ce0d7SJeremy L Thompson
3*8a4ce0d7SJeremy L Thompsonon:
4*8a4ce0d7SJeremy L Thompson  push:
5*8a4ce0d7SJeremy L Thompson    branches:
6*8a4ce0d7SJeremy L Thompson      - main
7*8a4ce0d7SJeremy L Thompson      - jeremy/rust
8*8a4ce0d7SJeremy L Thompson    tags: '*'
9*8a4ce0d7SJeremy L Thompson
10*8a4ce0d7SJeremy L Thompsonjobs:
11*8a4ce0d7SJeremy L Thompson  build:
12*8a4ce0d7SJeremy L Thompson    strategy:
13*8a4ce0d7SJeremy L Thompson      matrix:
14*8a4ce0d7SJeremy L Thompson        os: [ubuntu-latest]
15*8a4ce0d7SJeremy L Thompson
16*8a4ce0d7SJeremy L Thompson    runs-on: ${{ matrix.os }}
17*8a4ce0d7SJeremy L Thompson
18*8a4ce0d7SJeremy L Thompson    steps:
19*8a4ce0d7SJeremy L Thompson    - name: Environment setup
20*8a4ce0d7SJeremy L Thompson      uses: actions/checkout@v2
21*8a4ce0d7SJeremy L Thompson    - name: Rust setup
22*8a4ce0d7SJeremy L Thompson      uses: actions-rs/toolchain@v1
23*8a4ce0d7SJeremy L Thompson      with:
24*8a4ce0d7SJeremy L Thompson        toolchain: stable
25*8a4ce0d7SJeremy L Thompson    - name: Build documentation
26*8a4ce0d7SJeremy L Thompson      run: |
27*8a4ce0d7SJeremy L Thompson        cd rust
28*8a4ce0d7SJeremy L Thompson        cargo doc --all --no-deps
29*8a4ce0d7SJeremy L Thompson        touch ./target/doc/.nojekyll
30*8a4ce0d7SJeremy L Thompson        echo "<meta http-equiv=refresh content=0;url=libceed/index.html>" > ./target/doc/index.html
31*8a4ce0d7SJeremy L Thompson        cd ..
32*8a4ce0d7SJeremy L Thompson    - name: Deploy documentation
33*8a4ce0d7SJeremy L Thompson      uses: peaceiris/actions-gh-pages@v3
34*8a4ce0d7SJeremy L Thompson      with:
35*8a4ce0d7SJeremy L Thompson        external_repository: CEED/libCEED-rust-docs
36*8a4ce0d7SJeremy L Thompson        deploy_key: ${{ secrets.RUST_DOCS_KEY }}
37*8a4ce0d7SJeremy L Thompson        publish_dir: ./rust/target/doc
38