Skip to content

Commit 4537356

Browse files
committed
Add comments to all justfile recipes
1 parent f99af49 commit 4537356

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

justfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
default:
22
@just --list
33

4+
# Build and serve the manual.
45
doc:
56
cd manual && mdbook serve --open
67

8+
# Run the output regression test.
79
compare:
810
sample_files/compare_all.sh
911

12+
# Create a git tag and push it, to trigger a release on GitHub actions.
1013
release:
1114
#!/bin/bash
1215

@@ -18,16 +21,19 @@ release:
1821

1922
cargo set-version --bump minor
2023

24+
# Serve the homepage locally.
2125
home:
2226
echo "http://localhost:8080"
2327
cd homepage && python -m http.server 8080
2428

29+
# Generate release notes for the currently unreleased version.
2530
rel_notes:
2631
#!/bin/bash
2732

2833
echo -e "Difftastic is a structural diff tool that understands syntax. See [the manual](https://difftastic.wilfred.me.uk/) to get started, and [the changelog](https://github.com/Wilfred/difftastic/blob/master/CHANGELOG.md) for historical changes.\n"
2934

3035
rg --max-count 1 -B 9999 "released " CHANGELOG.md | tail -n +3 | head -n -2 | awk 'BEGIN{RS="\n\n"; ORS="\n\n"} {gsub(/\n/, " "); print}'
3136

37+
# Regenerate the man page difft.1 from diff.1.md.
3238
man:
3339
pandoc --standalone --to man difft.1.md -o difft.1

0 commit comments

Comments
 (0)