Skip to content

Commit

Permalink
Rust Docs + GH workflow cleanup (#320)
Browse files Browse the repository at this point in the history
  • Loading branch information
justsmth authored Jan 26, 2024
1 parent cc56479 commit b68620b
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 9 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ jobs:
run: cargo clippy ${{ matrix.features }} --all-targets -- -W clippy::all -W clippy::pedantic -D warnings

apidiff:
if: github.repository == 'aws/aws-lc-rs'
runs-on: ubuntu-latest
strategy:
fail-fast: false
Expand Down Expand Up @@ -110,6 +111,7 @@ jobs:
allow-licenses: Apache-2.0, ISC, MIT, MIT-0

udeps:
if: github.repository == 'aws/aws-lc-rs'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand All @@ -134,6 +136,7 @@ jobs:
RUSTC_WRAPPER: ""

mirai-analysis:
if: github.repository == 'aws/aws-lc-rs'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down Expand Up @@ -176,6 +179,7 @@ jobs:
cargo mirai
minimal-versions:
if: github.repository == 'aws/aws-lc-rs'
name: Resolve the dependencies to the minimum SemVer version
runs-on: ubuntu-latest
steps:
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/cross.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ env:

jobs:
aws-lc-rs-cross-test:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs cross tests
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -57,6 +58,7 @@ jobs:
run: cross test --release --features bindgen,unstable --target ${{ matrix.target }}

aws-lc-rs-platform-build:
if: github.repository == 'aws/aws-lc-rs'
name: Cross-platform build
runs-on: ${{ matrix.os }}
strategy:
Expand All @@ -81,4 +83,3 @@ jobs:
run: cargo test --features bindgen,unstable --target ${{ matrix.target }}
env:
DYLD_ROOT_PATH: "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot"

Original file line number Diff line number Diff line change
@@ -1,28 +1,41 @@
name: Deploy User Guide
name: Deploy Documentation
on:
push:
branches:
- main
tags:
- v1.*
jobs:
deploy-user-guide:
if: github.repository == 'aws/aws-lc-rs'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
persist-credentials: false
- name: Install Rust Toolchain
submodules: 'recursive'
- name: Install Stable Rust Toolchain
uses: dtolnay/rust-toolchain@stable
id: toolchain
- name: Install Nightly Rust Toolchain
uses: dtolnay/rust-toolchain@nightly
id: toolchain
- name: Set Rust toolchain override
run: rustup override set ${{ steps.toolchain.outputs.name }}
- uses: actions/setup-go@v4
with:
go-version: '>=1.18'
- name: Build and Test User Guide
run: |
curl -L https://github.com/rust-lang/mdBook/releases/download/v0.4.34/mdbook-v0.4.34-x86_64-unknown-linux-gnu.tar.gz | tar xz
./mdbook build book
./mdbook test book
- name: Deploy User Guide
- name: Build Documentation
run: cargo +nightly doc --features fips,unstable --no-deps --workspace
- name: Copy docs
run: |
cp --recursive target/doc -t book/book/rustdocs/${{ github.ref_name }}
- name: Deploy Docs
uses: JamesIves/github-pages-deploy-action@v4
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: book/book
folder: book/book
2 changes: 2 additions & 0 deletions .github/workflows/fips.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ env:

jobs:
fips-test:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs fips-tests
runs-on: ${{ matrix.os }}
env:
Expand Down Expand Up @@ -50,6 +51,7 @@ jobs:
# See: https://github.com/rust-lang/cargo/issues/8531
run: cargo test --tests ${{ matrix.args }}
windows-fips-test:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs windows-fips-tests
runs-on: ${{ matrix.os }}
strategy:
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ env:

jobs:
s2n-quic-integration:
if: github.repository == 'aws/aws-lc-rs'
name: s2n-quic-integration
runs-on: ${{ matrix.os }}
strategy:
Expand All @@ -35,6 +36,7 @@ jobs:
./scripts/run-s2n-quic-integration.sh
rustls-integration:
if: github.repository == 'aws/aws-lc-rs'
name: rustls-integration
runs-on: ${{ matrix.os }}
strategy:
Expand All @@ -55,4 +57,3 @@ jobs:
working-directory: ./aws-lc-rs
run: |
./scripts/run-rustls-integration.sh
11 changes: 10 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ env:

jobs:
sys-crate-tests:
if: github.repository == 'aws/aws-lc-rs'
name: sys crate tests
runs-on: ${{ matrix.os }}
strategy:
Expand All @@ -38,6 +39,7 @@ jobs:
run: cargo run --features ${{ matrix.features }} --no-default-features

aws-lc-rs-test:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs tests
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -70,6 +72,7 @@ jobs:
run: cargo test --all-targets

bindgen-test:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs bindgen-tests
runs-on: ${{ matrix.os }}
strategy:
Expand All @@ -95,13 +98,14 @@ jobs:
run: cargo test ${{ matrix.args }}

windows-test:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs windows-tests
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
rust: [ stable ]
os: [ windows-2019 ]
os: [ windows-2019, windows-2022 ]
args:
- --all-targets --features unstable
- --all-targets --features bindgen,unstable
Expand All @@ -126,6 +130,7 @@ jobs:
run: cargo test ${{ matrix.args }}

publish-dry-run:
if: github.repository == 'aws/aws-lc-rs'
name: publish dry-run
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -196,6 +201,7 @@ jobs:
files: ${{ runner.temp }}/lcov.info,${{ runner.temp }}/lcov-fips.info

aws-lc-rs-asan:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs asan
strategy:
matrix:
Expand Down Expand Up @@ -225,6 +231,7 @@ jobs:
run: cargo test ${{ matrix.args }} --lib --bins --tests --examples --target x86_64-unknown-linux-gnu --features asan

build-env-test:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs build-env-test
runs-on: ${{ matrix.os }}
strategy:
Expand All @@ -247,6 +254,7 @@ jobs:
run: AWS_LC_SYS_STATIC=${{ matrix.static }} cargo test --tests

build-env-fips-test:
if: github.repository == 'aws/aws-lc-rs'
name: aws-lc-rs build-env-fips-test
runs-on: ${{ matrix.os }}
strategy:
Expand All @@ -273,6 +281,7 @@ jobs:
run: AWS_LC_FIPS_SYS_STATIC=${{ matrix.static }} cargo test --tests --features fips

careful:
if: github.repository == 'aws/aws-lc-rs'
name: Run carefully
runs-on: ${{ matrix.os }}
strategy:
Expand Down

0 comments on commit b68620b

Please sign in to comment.