Add note explaining double debug info usage (#273) #269
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: Publish | |
| on: | |
| push: | |
| branches: | |
| - master | |
| workflow_dispatch: | |
| inputs: | |
| error_debug: | |
| type: boolean | |
| required: false | |
| default: false | |
| force_debug: | |
| type: boolean | |
| required: false | |
| default: false | |
| jobs: | |
| publish-tutorial: | |
| name: Publish - Tutorial | |
| runs-on: ubuntu-latest | |
| env: | |
| RUST_LOG: info | |
| RUST_VERSION: 1.70.0 | |
| MDBOOK_VERSION: 0.4.21 | |
| steps: | |
| # Checkout | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| # Dependencies | |
| - name: Install Java | |
| uses: actions/setup-java@v1 | |
| with: | |
| java-version: 21 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: ${{ env.RUST_VERSION }} | |
| components: rustfmt | |
| - name: Cache mdbook | |
| id: cache-mdbook | |
| uses: actions/cache@v2 | |
| with: | |
| path: ~/.cargo/bin/mdbook | |
| key: ${{ runner.os }}-${{ env.RUST_VERSION }}-${{ env.MDBOOK_VERSION }} | |
| - name: Install mdbook | |
| if: steps.cache-mdbook.outputs.cache-hit != 'true' | |
| run: cargo install mdbook --version ${{ env.MDBOOK_VERSION }} --no-default-features | |
| # Publish | |
| - name: Build Index | |
| working-directory: ./generator | |
| run: ./gradlew run --args="--directory=.. index" | |
| - name: Cache Preprocessor | |
| id: cache-preprocessor | |
| uses: actions/cache@v2 | |
| with: | |
| path: ~/.cargo/bin/vk-preprocessor | |
| key: ${{ hashFiles('index.txt', 'tutorial/book/preprocessor/**') }} | |
| - name: Build Preprocessor | |
| if: steps.cache-preprocessor.outputs.cache-hit != 'true' | |
| run: cargo install --path ./tutorial/book/preprocessor | |
| - name: Build Tutorial | |
| working-directory: ./tutorial/book | |
| run: mdbook build | |
| - name: Publish Tutorial | |
| uses: JamesIves/[email protected] | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: ./tutorial/book/book | |
| CLEAN: true | |
| # Debug | |
| - name: Debug | |
| uses: mxschmitt/action-tmate@v3 | |
| if: ${{ (failure() && inputs.error_debug) || inputs.force_debug }} |