Skip to content

Build and check Swift snippets #42

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
sean-parent merged 13 commits into from
Mar 23, 2026
Merged

Build and check Swift snippets #42

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
607cd08
Add swift example checking to , fix broken examples, add to CI
nickpdemarco Feb 3, 2026
bcbaf31
use swift@v3
nickpdemarco Feb 4, 2026
b455b0c
Simplify and docuemnt implementation
nickpdemarco Feb 11, 2026
8c04b1e
Remove obsolete comment
nickpdemarco Feb 11, 2026
a7496fb
Consistent spacing
nickpdemarco Feb 11, 2026
515aebe
Remove needless comment
nickpdemarco Feb 12, 2026
f6dc031
Respond to Dave's constructive feedback
nickpdemarco Feb 12, 2026
9ffb886
Ignore fewer blocks and fix errors
nickpdemarco Feb 12, 2026
b6c3837
Fix comment
nickpdemarco Feb 12, 2026
d8c220f
Minor comment fixes
nickpdemarco Feb 12, 2026
230a796
Skip swift tests on windows
nickpdemarco Mar 16, 2026
d29a457
Merge main
nickpdemarco Mar 16, 2026
8309cd4
Try to use setup-swift v2 to avoid gpg issue
nickpdemarco Mar 16, 2026
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
6 changes: 5 additions & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ jobs:
- name: Install mdBook and plugins (Windows)
if: runner.os == 'Windows'
run: .\scripts\install-tools.ps1


# Install Swift for testing Swift code examples in the book
- name: Setup Swift
uses: swift-actions/setup-swift@v2

- name: Build with mdBook
run: mdbook build ./better-code

Expand Down
11 changes: 11 additions & 0 deletions better-code/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ description = "A principled and rigorous approach to software development"
[build]
build-dir = "book"

# Preprocessor to hide `# ` lines in Swift code blocks (like mdbook does for Rust)
# Only strips lines for HTML output; swift-test backend sees the full code
[preprocessor.swift-hidden]
command = "python3 scripts/mdbook-swift-hidden.py"
Copy link
Copy Markdown
Member

@sean-parent sean-parent Feb 4, 2026

Choose a reason for hiding this comment

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

Can you use the built-in mdbook support?

[output.html.code.hidelines]
swift = "#"

Copy link
Copy Markdown
Contributor

@dabrahams dabrahams Feb 4, 2026

Choose a reason for hiding this comment

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

Swift has # directives so might need a different character

Copy link
Copy Markdown
Member Author

@nickpdemarco nickpdemarco Feb 4, 2026

Choose a reason for hiding this comment

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

It seems to work! Huge simplification, thanks for pointing that out.


[output.html]
git-repository-url = "https://github.com/stlab/better-code"
edit-url-template = "https://github.com/stlab/better-code/edit/main/better-code/src/{path}"
Expand All @@ -19,3 +24,9 @@ enable = true

[output.html.print]
enable = true

# Swift code example testing backend
Comment thread
nickpdemarco marked this conversation as resolved.
Outdated
# Tests all Swift code blocks during `mdbook build`
# See scripts/mdbook-swift-test.py for implementation
[output.swift-test]
command = "python3 ../../../scripts/mdbook-swift-test.py"
Loading
Loading