Skip to content

Website: use git grep to check OCaml ref + update absolute links #1534

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 13, 2025
+5 −6
Merged

Website: use git grep to check OCaml ref + update absolute links #1534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27f8f72
Website: use link to GH repo of transaction_logic/mod.rs
dannywillems Oct 13, 2025
f175b2e
CI: use git grep instead of ripgrep, and enforce bash
dannywillems Oct 13, 2025
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 .github/scripts/check-ocaml-refs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ echo "Current OCaml commit: ${CURRENT_COMMIT}"

# Find all Rust files with OCaml references
cd "${RUST_ROOT}"
RUST_FILES=$(rg -l "^/// OCaml reference:" --type rust || true)
RUST_FILES=$(git grep -l -E "^/// OCaml reference:" "*.rs" "**/*.rs" || true)

if [ -z "$RUST_FILES" ]; then
echo "No OCaml references found in Rust code"
Expand Down
4 changes: 1 addition & 3 deletions .github/workflows/check-ocaml-refs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,12 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v5

- name: Install ripgrep
run: sudo apt-get update && sudo apt-get install -y ripgrep

- name: Run OCaml reference validation
id: check
env:
OCAML_REPO: ${{ github.event.inputs.repo || 'https://github.com/MinaProtocol/mina.git' }}
OCAML_BRANCH: ${{ github.event.inputs.branch || 'compatible' }}
shell: bash
run: |
set +e
# Capture output to file
Expand Down
5 changes: 3 additions & 2 deletions website/docs/developers/ocaml-reference-tracking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,5 +131,6 @@ For single-line references, use the same number: `L:42-42`

## Example references

See `ledger/src/scan_state/transaction_logic/mod.rs` for examples of properly
formatted OCaml references.
See
[`ledger/src/scan_state/transaction_logic/mod.rs`](https://github.com/o1-labs/mina-rust/blob/develop/ledger/src/scan_state/transaction_logic/mod.rs)
for examples of properly formatted OCaml references.
Loading