adds doc comment #913
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: Miri test | |
| on: [ push, pull_request ] | |
| jobs: | |
| build: | |
| name: Test with Miri | |
| runs-on: ${{ matrix.os }} | |
| # We want to run on external PRs, but not on internal ones as push automatically builds | |
| # H/T: https://github.com/Dart-Code/Dart-Code/commit/612732d5879730608baa9622bf7f5e5b7b51ae65 | |
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'amazon-ion/ion-rust' | |
| strategy: | |
| matrix: | |
| os: [ ubuntu-latest, windows-latest, macos-latest ] | |
| # build and test for experimental features with miri | |
| features: [ 'experimental' ] | |
| permissions: | |
| checks: write | |
| steps: | |
| - name: Git Checkout | |
| uses: actions/checkout@v2 | |
| with: | |
| submodules: recursive | |
| - name: Rust Toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: nightly | |
| components: miri | |
| override: true | |
| - name: Install Miri | |
| run: | | |
| rustup toolchain install nightly --component miri | |
| rustup override set nightly | |
| cargo miri setup | |
| - name: Test with Miri (ubuntu and macos) | |
| # miri test for Linux and macOS os, since Windows os requires a different syntax to enable miri flags | |
| if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest' | |
| # Miri flags | |
| # | |
| # -Zmiri-disable-isolation | |
| # We need to pass the miri flag to disable host isolation in order to access host for clock information on timestamps | |
| # more information can be found: https://github.com/rust-lang/miri#miri--z-flags-and-environment-variables | |
| # | |
| # -Zmiri-tree-borrows | |
| # Miri's default aliasing model (stacked borrows) is known to be unnecessarily restrictive. Their alternative | |
| # aliasing model (tree borrows) accepts valid programs that stacked borrows would reject. | |
| # For more information, see: https://www.ralfj.de/blog/2023/06/02/tree-borrows.html | |
| run: MIRIFLAGS="-Zmiri-disable-isolation -Zmiri-tree-borrows" cargo miri test serde --features "${{ matrix.features }}" | |
| - name: Test with Miri (windows) | |
| if: matrix.os == 'windows-latest' | |
| run: $env:MIRIFLAGS="-Zmiri-disable-isolation -Zmiri-tree-borrows" ; cargo miri test serde --features "${{ matrix.features }}" |