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 binary target to example commands #509

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

microbecode
Copy link

Pull Request type

  • Bugfix
  • Documentation content changes

What is the current behavior?

Example commands do not work and give an error.

Resolves: #508

What is the new behavior?

Specify the used binary explicitly to make the example commands work again.

Does this introduce a breaking change?

No

Other information

@microbecode microbecode mentioned this pull request Mar 1, 2025
1 task
Copy link

@HermanObst HermanObst left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@Trantorian1 Trantorian1 left a comment

Choose a reason for hiding this comment

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

Looking good!

Note

I wonder if there is a way for us to validate the commands in the docs as part of the CI so this issue does not happen in the future, kind of how rustdoc requires code snippets to compile.

@Trantorian1
Copy link
Collaborator

After some research I could not find any ready-made tool that would help us with this.

It seems like it would be easy enough though to write a rust binary using pulldown_cmark to parse out the cli commands from our README.md and execute them as part of a CI action. I am more familiar with rust but I guess for CI it might be easier to write this in an interpreted language.

Anyway, extracting the code blocks and just running those commands and checking for an error code + terminating after n seconds so we don't accidentally run a full node as part of continuous development should be doable :D

@microbecode
Copy link
Author

Waiting for someone to merge! Thanks

@Trantorian1 Trantorian1 added the docs Documentation changes or improvements label Mar 4, 2025
@microbecode
Copy link
Author

@Trantorian1
image

@microbecode microbecode mentioned this pull request Mar 4, 2025
1 task
@microbecode
Copy link
Author

Opened a new issue for the automatic checking: #511

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation changes or improvements
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Example commands are broken
3 participants