book: Clarify function in main_event_loop #2796
Workflow file for this run
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: book | |
| on: | |
| pull_request: | |
| paths: | |
| - "book/**" | |
| push: | |
| branches: | |
| - "master" | |
| paths: | |
| - "book/**" | |
| jobs: | |
| check: | |
| runs-on: ubuntu-22.04 | |
| name: build | |
| if: ${{ github.event_name == 'pull_request' }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| override: true | |
| - name: Setup mdBook | |
| uses: peaceiris/actions-mdbook@v1 | |
| - run: mdbook build -d public | |
| working-directory: book | |
| - name: Link Checker | |
| uses: lycheeverse/[email protected] | |
| with: | |
| args: book/public | |
| fail: true | |
| build-deploy: | |
| runs-on: ubuntu-22.04 | |
| name: build | |
| if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/master') || github.event_name == 'release' }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| override: true | |
| - name: Setup mdBook | |
| uses: peaceiris/actions-mdbook@v1 | |
| - run: mdbook build -d public | |
| working-directory: book | |
| - name: Deploy to stable | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./book/public | |
| keep_files: false | |
| destination_dir: stable/latest/book |