Skip to content

Website: move node management commands into scripts and test in CI #1511

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

Jump to bottom
Open
dannywillems wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

Website: move node management commands into scripts and test in CI #1511

dannywillems wants to merge 6 commits into from

Conversation

@dannywillems
Copy link
Member

@dannywillems dannywillems commented Oct 6, 2025

No description provided.

@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch 4 times, most recently from 936cfcf to fabab65 Compare October 6, 2025 17:31
@dannywillems dannywillems moved this to Done in Rust node Oct 6, 2025
@dannywillems dannywillems requested a review from yamimaio October 6, 2025 17:40
@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch from d3f2f70 to e627c47 Compare October 7, 2025 15:25
@dannywillems dannywillems self-assigned this Oct 7, 2025
@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch 2 times, most recently from 6b41778 to ec095cc Compare October 7, 2025 16:18
yamimaio
yamimaio reviewed Oct 7, 2025
View reviewed changes
.github/workflows/test-docs-scripts-node-management.yaml
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-22.04, ubuntu-24.04]
Copy link
Collaborator

@yamimaio yamimaio Oct 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only ubuntu?

Copy link
Member Author

@dannywillems dannywillems Oct 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'm struggling adding macOS for the scripts using docker.

@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch from ec095cc to 450fd7d Compare October 8, 2025 12:05
@dannywillems dannywillems moved this from Done to In Progress in Rust node Oct 8, 2025
@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch from 450fd7d to a4948b3 Compare October 9, 2025 13:56
@github-actions
Copy link

github-actions bot commented Oct 9, 2025 •
edited
Loading

✓ Code Reference Verification Passed

All code references in the documentation have been verified successfully!

Total references checked: 1
Valid references: 1

The documentation is in sync with the codebase on the develop branch.

@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch 2 times, most recently from e76a3dc to d225320 Compare October 10, 2025 12:49
@dannywillems dannywillems moved this from In Progress to Todo in Rust node Oct 20, 2025
@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch 2 times, most recently from d40f72e to ec1f84d Compare December 12, 2025 01:30
@github-actions
Copy link

github-actions bot commented Dec 12, 2025 •
edited
Loading

OCaml Reference Validation Results

Repository: https://github.com/MinaProtocol/mina.git
Branch: compatible
Status: ❌ Validation failed

Click to see full validation output 
Checking OCaml references against https://github.com/MinaProtocol/mina.git (branch: compatible)
Fetching current commit from compatible...
Current OCaml commit: 84eb5ae0fa74cb234a9596d198b433abca8286e0

Validating references...
========================
✓ VALID: ledger/src/account/account.rs -> src/lib/mina_base/account.ml L:201-224
  ⚠ STALE COMMIT: fc6be4c58091c761f827c858229c2edf9519e941 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
❌ INVALID: ledger/src/scan_state/transaction_logic/for_tests.rs
   Code at L:2285-2285 differs between commit 5da42ccd72e791f164d4d200cf1ce300262873b3 and current branch
   Referenced: https://github.com/MinaProtocol/mina/blob/5da42ccd72e791f164d4d200cf1ce300262873b3/src/lib/transaction_logic/mina_transaction_logic.ml#L2285-L2285
   Current:    https://github.com/MinaProtocol/mina/blob/compatible/src/lib/transaction_logic/mina_transaction_logic.ml#L2285-L2285
❌ INVALID: ledger/src/scan_state/transaction_logic/for_tests.rs
   Code at L:2351-2356 differs between commit 5da42ccd72e791f164d4d200cf1ce300262873b3 and current branch
   Referenced: https://github.com/MinaProtocol/mina/blob/5da42ccd72e791f164d4d200cf1ce300262873b3/src/lib/transaction_logic/mina_transaction_logic.ml#L2351-L2356
   Current:    https://github.com/MinaProtocol/mina/blob/compatible/src/lib/transaction_logic/mina_transaction_logic.ml#L2351-L2356
❌ INVALID: ledger/src/scan_state/transaction_logic/for_tests.rs
   Code at L:2407 differs between commit 5da42ccd72e791f164d4d200cf1ce300262873b3 and current branch
   Referenced: https://github.com/MinaProtocol/mina/blob/5da42ccd72e791f164d4d200cf1ce300262873b3/src/lib/transaction_logic/mina_transaction_logic.ml#L2407-L2407
   Current:    https://github.com/MinaProtocol/mina/blob/compatible/src/lib/transaction_logic/mina_transaction_logic.ml#L2407-L2407
✓ VALID: ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/transaction_status.ml L:9-51
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/transaction_status.ml L:452-454
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/with_status.ml L:6-10
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/fee_transfer.ml L:76-80
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/fee_transfer.ml L:68-69
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/mina_base/coinbase.ml L:17-21
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/mod.rs -> src/lib/transaction/transaction.ml L:8-11
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/signed_command_payload.ml L:34-48
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/stake_delegation.ml L:11-13
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/signed_command_payload.ml L:179-181
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/signed_command_payload.ml L:239-243
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)
✓ VALID: ledger/src/scan_state/transaction_logic/signed_command.rs -> src/lib/mina_base/signed_command_payload.ml L:352-362
  ⚠ STALE COMMIT: 5da42ccd72e791f164d4d200cf1ce300262873b3 (current: 84eb5ae0fa74cb234a9596d198b433abca8286e0)

Summary
=======
Total references found: 16
Valid references: 13
Invalid references: 3
Stale commits: 13

❌ Validation failed: 3 invalid reference(s) found

@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch from ec1f84d to 3cdbfbe Compare December 12, 2025 01:35
@dannywillems
Website/node-management: extract build-info commands to scripts
cc58386 
Extracted all build-info command examples from the node-management
documentation into separate shell scripts that can be tested in CI,
following the same pattern used in the developer documentation.

Changes:
- Created website/docs/node-operators/scripts/ directory
- Added build-info-docker.sh for basic Docker usage
- Added build-info-docker-version.sh for specific version
- Added build-info-native.sh for native binary
- Added build-info-native-path.sh for full path usage
- Added verify-build-info-docker.sh for Docker verification
- Added verify-build-info-native.sh for native verification
- Converted node-management.md to .mdx
- Updated documentation to use CodeBlock imports with raw-loader
@dannywillems
CI: add workflow to test node-operators documentation scripts
f9984f3 
Created a new CI workflow to test the node-operators documentation
scripts, ensuring the build-info command examples work correctly
across different platforms.

The workflow tests:
- build-info-docker.sh - Basic Docker build-info command
- build-info-docker-version.sh - Version-specific build-info
- verify-build-info-docker.sh - Build-info verification with grep

Tested on: ubuntu-22.04, ubuntu-24.04, macos-latest

Changes:
- Added .github/workflows/test-docs-scripts-node-operators.yaml
@dannywillems
Website/node management: fix rendering
2deb227
@dannywillems
Website/node-management: move example outputs to files and verify in CI
6eff7a7 
Move build-info example output and management script examples into
separate files that are imported by the documentation. Add CI
verification to ensure scripts work correctly and output matches
documented examples.

Changes:
- Move build-info example output to build-info-example.txt
- Create check-build-info-format.sh to verify output format
- Combine backup scripts into backup-configuration.sh
- Create manage-file-permissions.sh (combined from 3 separate scripts)
- Create check-system-resources.sh
- Create .env file creation scripts (empty, custom, archive variants)
- Add test-management-scripts job to CI workflow
- Add gh act run command comment to workflow
- Update documentation to use CodeBlock imports for all scripts

All scripts are tested in CI on ubuntu-22.04, ubuntu-24.04, and
macos-latest to ensure they execute correctly.
@dannywillems
CHANGELOG: add entry for patch 1511
a8efa0d
@dannywillems
CI: rename file to correspond to the page
c87f229
@dannywillems dannywillems force-pushed the dw/node-management-doc-in-ci branch from 3cdbfbe to c87f229 Compare December 12, 2025 02:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yamimaio yamimaio yamimaio left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@dannywillems dannywillems

Labels

None yet

Projects

Rust node
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dannywillems @yamimaio