ci: also test cargo doc

removed step from RELEASING.md: now CI tests it for us
This commit is contained in:
əlemi 2025-02-18 17:08:29 +01:00 committed by alemi.dev
parent 83c5614c01
commit 1cb2397a59
2 changed files with 10 additions and 2 deletions
.github/workflows
dist

View file

@ -20,6 +20,16 @@ jobs:
- uses: dtolnay/rust-toolchain@stable
- run: cargo test --verbose
test-doc:
runs-on: ubuntu-latest
steps:
- uses: arduino/setup-protoc@v3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- run: cargo doc --features=serialize
test-beta:
runs-on: ubuntu-latest
needs: [test-unit]

2
dist/RELEASING.md vendored
View file

@ -23,8 +23,6 @@ Before writing the tag, make sure all these steps have been followed:
- note that the rockspec file contains current version in its name so must be renamed
- note that rockspec versions have a fourth component: "revision". we don't use it so always set is as `1`
- [ ] update `Cargo.lock` (basically delete it and re-run `cargo build`. check diff before committing!)
- [ ] **make sure docs build without warning or errors** (`cargo doc --features=serialize`)
- [ ] **make sure that core crate builds** with `--release --features=js,py,java,lua`
- [ ] **make sure the version you're about to release is available** (on all registries!)
- [ ] update last tag in "commits since last tag" badge (in README.md)
- [ ] commit all these changes (in `release/vX.Y.Z` branch), open a PR and have it approved and merged