From 1cb2397a59af776b043e3b2d3ca974bd00e60f18 Mon Sep 17 00:00:00 2001
From: alemi <me@alemi.dev>
Date: Tue, 18 Feb 2025 17:08:29 +0100
Subject: [PATCH] ci: also test cargo doc
removed step from RELEASING.md: now CI tests it for us
---
.github/workflows/test.yml | 10 ++++++++++
dist/RELEASING.md | 2 --
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 7675bdf..8d3d55e 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -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]
diff --git a/dist/RELEASING.md b/dist/RELEASING.md
index d5f643f..d6c6f69 100644
--- a/dist/RELEASING.md
+++ b/dist/RELEASING.md
@@ -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