Skip to content

Commit ca0cc7a

Browse files
committed
ci: also test cargo doc
removed step from RELEASING.md: now CI tests it for us
1 parent 0507397 commit ca0cc7a

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

.github/workflows/test.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ jobs:
2020
- uses: dtolnay/rust-toolchain@stable
2121
- run: cargo test --verbose
2222

23+
test-doc:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- uses: arduino/setup-protoc@v3
27+
with:
28+
repo-token: ${{ secrets.GITHUB_TOKEN }}
29+
- uses: actions/checkout@v4
30+
- uses: dtolnay/rust-toolchain@stable
31+
- run: cargo doc --features=serialize
32+
2333
test-beta:
2434
runs-on: ubuntu-latest
2535
needs: [test-unit]

dist/RELEASING.md

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

0 commit comments

Comments
 (0)