Skip to content

Commit 0b95c76

Browse files
authored
docs: add VHS tape for bump command GIF (#1878)
* docs: add VHS tape for bump command GIF * docs: replace bump GIF with VHS-generated version
1 parent cd7e086 commit 0b95c76

File tree

4 files changed

+135
-1
lines changed

4 files changed

+135
-1
lines changed

docs/commands/bump.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Bump version](../images/bump.gif)
1+
![Bump version](../images/cli_interactive/bump.gif)
22

33
## About
44

docs/images/bump.gif

-93.6 KB
Binary file not shown.

docs/images/bump.tape

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
Output cli_interactive/bump.gif
2+
3+
Require cz
4+
5+
# Use bash for cross-platform compatibility (macOS, Linux, Windows)
6+
Set Shell bash
7+
8+
Set FontSize 16
9+
Set Width 878
10+
Set Height 568
11+
Set Padding 20
12+
Set TypingSpeed 50ms
13+
14+
Set Theme {
15+
"name": "Commitizen",
16+
"black": "#232628",
17+
"red": "#fc4384",
18+
"green": "#b3e33b",
19+
"yellow": "#ffa727",
20+
"blue": "#75dff2",
21+
"magenta": "#ae89fe",
22+
"cyan": "#708387",
23+
"white": "#d5d5d0",
24+
"brightBlack": "#626566",
25+
"brightRed": "#ff7fac",
26+
"brightGreen": "#c8ed71",
27+
"brightYellow": "#ebdf86",
28+
"brightBlue": "#75dff2",
29+
"brightMagenta": "#ae89fe",
30+
"brightCyan": "#b1c6ca",
31+
"brightWhite": "#f9f9f4",
32+
"background": "#1e1e2e",
33+
"foreground": "#afafaf",
34+
"cursor": "#c7c7c7"
35+
}
36+
37+
# Hide initial shell prompt
38+
Hide
39+
40+
# Wait for terminal to be ready
41+
Sleep 1s
42+
43+
# Set a clean, simple prompt (while hidden)
44+
Type "PS1='$ '"
45+
Enter
46+
Sleep 300ms
47+
48+
# Create a clean temporary directory for recording
49+
Type "rm -rf /tmp/commitizen-example && mkdir -p /tmp/commitizen-example && cd /tmp/commitizen-example"
50+
Enter
51+
Sleep 500ms
52+
53+
# Initialize git repository
54+
Type "git init"
55+
Enter
56+
Type "git config user.email 'you@example.com'"
57+
Enter
58+
Type "git config user.name 'Your Name'"
59+
Enter
60+
Sleep 500ms
61+
62+
# Initialize commitizen config with version 0.0.1 and changelog enabled
63+
Type `cat > pyproject.toml << 'EOF'`
64+
Enter
65+
Sleep 100ms
66+
Type `[tool.commitizen]`
67+
Enter
68+
Sleep 100ms
69+
Type `version = "0.0.1"`
70+
Enter
71+
Sleep 100ms
72+
Type `update_changelog_on_bump = true`
73+
Enter
74+
Sleep 100ms
75+
Type "EOF"
76+
Enter
77+
Sleep 300ms
78+
79+
# Create initial commit (no tag, so cz bump will ask "Is this the first tag created?")
80+
Type "git add pyproject.toml"
81+
Enter
82+
Sleep 300ms
83+
84+
Type "git commit -m 'chore: initial commit'"
85+
Enter
86+
Sleep 500ms
87+
88+
# Create a feat commit that will trigger a MINOR bump (0.0.1 -> 0.1.0)
89+
Type "echo 'new feature' > feature.py"
90+
Enter
91+
Sleep 300ms
92+
93+
Type "git add feature.py"
94+
Enter
95+
Sleep 300ms
96+
97+
Type "git commit -m 'feat: add awesome new feature'"
98+
Enter
99+
Sleep 500ms
100+
101+
# Clear the screen to start fresh
102+
Type "clear"
103+
Enter
104+
Sleep 500ms
105+
106+
# Show commands from here
107+
Show
108+
109+
# Step 1: Show current version
110+
Type "cz version --project"
111+
Sleep 500ms
112+
Enter
113+
Sleep 1s
114+
115+
# Step 2: Run cz bump (no existing tag, will prompt for first tag)
116+
Type "cz bump"
117+
Sleep 500ms
118+
Enter
119+
120+
# Wait for the "Is this the first tag created?" prompt
121+
Sleep 2s
122+
123+
# Answer Yes to "Is this the first tag created?" (default is Yes, just press Enter)
124+
Enter
125+
Sleep 3s
126+
127+
# Step 3: Show new version after bump
128+
Type "cz version --project"
129+
Sleep 500ms
130+
Enter
131+
Sleep 1s
132+
133+
# Wait for final output
134+
Sleep 3s
83.9 KB
Loading

0 commit comments

Comments
 (0)