Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation formatting check to CI #553

Merged
merged 4 commits into from
Jul 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ jobs:
command: ./scripts/clippy_check.sh
- run:
name: Format check
command: cargo +nightly-2024-07-08 fmt --all --check
command: ./scripts/format_check.sh
- run:
name: Code spell check
command: ./scripts/check_spelling.sh
Expand Down
3 changes: 1 addition & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ To release a new Devnet version, follow these steps:
2. Add a documentation entry for the incoming version by running:

```
$ cd website
$ npm run docusaurus docs:version <VERSION>
$ npm --prefix website run docusaurus docs:version <VERSION>
```

3. Create a PR styled after [this one](https://github.com/0xSpaceShard/starknet-devnet-rs/pull/473).
Expand Down
6 changes: 2 additions & 4 deletions scripts/format.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,5 @@ set -eu

cargo +nightly-2024-07-08 fmt --all

# Format documentation code
cd website
npm run format
cd ..
# Format documentation
npm --prefix website run format
8 changes: 8 additions & 0 deletions scripts/format_check.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/bash

set -euo pipefail

cargo +nightly-2024-07-08 fmt --all --check

# Format documentation
npm --prefix website run format-check