docs: add note about thread-safety #14
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: Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "github-pages" | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v2 | |
| - uses: actions/setup-python@v2 | |
| - name: Install rust | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| profile: minimal | |
| override: true | |
| - name: Run tests | |
| run: | | |
| cargo test | |
| id: test | |
| - name: Build cargo doc | |
| run: | | |
| rm -rf ./_site | |
| cargo doc --lib --no-deps | |
| rm -f target/doc/.lock | |
| cp -r target/doc _site | |
| echo "<meta http-equiv=\"refresh\" content=\"0; url=owned_ref_cell\">" > _site/index.html | |
| chmod -R +rX _site | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v3 |