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

feat: testable book-of-bdk #1

Merged
merged 5 commits into from
Oct 16, 2023
Merged

feat: testable book-of-bdk #1

merged 5 commits into from
Oct 16, 2023

Conversation

realeinherjar
Copy link
Contributor

  • Automated CI in GitHub Actions that test all the code in the cookbook: .github/workflows/test.yml
  • Automated scheduled CI in GitHub Actions that check all markdown files for broken links (we are adding a LOT of links): .github/workflows/check-links.yml
  • Dependabot to update (weekly) .github/dependabot.yml:
    • GitHub Actions
    • Test dependencies, this is good once we release bdk new versions (and move from the git versions to releases of the crates) dependabot will open a PR here to update
  • justfile to easy run the build and test with just
  • Make book/wallet.md testable.

Details

I want this cookbook to be tested automatically on CI, so the code will always run.
The only solution that worked for me was this workaround that is used in The Rust Rand Book.

Also some code blocks I don't want to test, but I wanted syntax highlighting.
An easy fix was to change the language on the fenced blocks from rust to rs.
This makes Vitepress render them as Rust, but they are untouched by ./tests/generate.sh and cargo test.

@realeinherjar
Copy link
Contributor Author

Ready to review

Copy link
Member

@thunderbiscuit thunderbiscuit left a comment

Choose a reason for hiding this comment

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

ACK 7587fce.

@thunderbiscuit thunderbiscuit merged commit 4343c84 into bitcoindevkit:master Oct 16, 2023
1 check passed
@thunderbiscuit thunderbiscuit temporarily deployed to github-pages October 16, 2023 18:41 — with GitHub Actions Inactive
@realeinherjar realeinherjar deleted the einherjar/book-ci branch October 16, 2023 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants