Skip to content

Commit 7d55a12

Browse files
authored
docs: update README.md (#135)
1 parent 0cc67f4 commit 7d55a12

22 files changed

+922
-127
lines changed

.claude/plan/48-docs-restructure.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454

5555
4. **Usage Examples** 🚧 - Copy-paste examples by command
5656
- **Content**:
57-
- **zerv flow**: Automated branch-based versions with comprehensive documentation:
57+
- **zerv flow**: Automated branch-based versions with comprehensive documentation:
5858
- ✅ **Core Principles**: 4 fundamental design principles
5959
- ✅ **Version Format Explained**: Structure, components, and variations with examples
6060
- ✅ **Pre-release Resolution Strategy**: Branch patterns, post-release logic, distance modes
@@ -67,13 +67,13 @@
6767
- ✅ **Branch Rules**: Configurable pattern matching (default GitFlow) for pre-release automation
6868
- ✅ **Pre-release Control**: Labels (alpha/beta/rc), numbers, hash-based identification
6969
- ✅ **Post Mode Options**: Tag distance vs commit distance calculation modes
70-
- **zerv version**: Manual control with 4 main capability areas:
70+
- **zerv version**: Manual control with 4 main capability areas:
7171
- ✅ **Schema Variants**: 20+ presets (standard, calver families) and custom RON schemas
7272
- ✅ **VCS Overrides**: Override tag version, distance, dirty state, branch, commit data
7373
- ✅ **Version Bumping**: Field-based bumps (major/minor/patch) and schema-based bumps
74-
- **Component Overrides**: Fine-grained control over individual version components
75-
- **zerv check**: Version validation for different formats
76-
- **Input/Output & Piping**: Shared capabilities for both zerv version and zerv flow:
74+
- **Component Overrides**: Fine-grained control over individual version components
75+
- **zerv check**: Version validation for different formats
76+
- **Input/Output & Piping**: Shared capabilities for both zerv version and zerv flow:
7777
- Source options: git, stdin
7878
- Output formats: semver, pep440, zerv
7979
- Template customization and prefix support

Cargo.lock

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Makefile

Lines changed: 3 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -34,71 +34,12 @@ test_easy:
3434
test:
3535
ZERV_TEST_NATIVE_GIT=false ZERV_TEST_DOCKER=true $(MAKE) _test
3636

37-
test_flaky:
38-
@echo "🚀 Starting flaky test detection with 5 iterations..."
39-
@echo "=================================================="
40-
@set -o pipefail; \
41-
start_time=$$(date +%s); \
42-
total_time=0; \
43-
success_count=0; \
44-
failed_iteration=0; \
45-
for i in 1 2 3 4 5; do \
46-
echo ""; \
47-
echo "=== Iteration $$i/5 ==="; \
48-
iter_start=$$(date +%s); \
49-
echo "⏰ Start time: $$(date)"; \
50-
echo "🔍 Running tests..."; \
51-
ZERV_TEST_NATIVE_GIT=false ZERV_TEST_DOCKER=true $(MAKE) _test 2>&1 | tee /tmp/test_output_$$i.log; \
52-
test_exit_code=$$?; \
53-
iter_end=$$(date +%s); \
54-
iter_duration=$$((iter_end - iter_start)); \
55-
if [ $$test_exit_code -eq 0 ]; then \
56-
total_time=$$((total_time + iter_duration)); \
57-
success_count=$$((success_count + 1)); \
58-
echo "✅ Iteration $$i completed successfully in $${iter_duration}s"; \
59-
echo "⏰ End time: $$(date)"; \
60-
rm -f /tmp/test_output_$$i.log; \
61-
else \
62-
failed_iteration=$$i; \
63-
echo ""; \
64-
echo "❌ FAILED at iteration $$i after $${iter_duration}s (exit code: $$test_exit_code)"; \
65-
echo "⏰ End time: $$(date)"; \
66-
echo ""; \
67-
echo "🚨 FLAKINESS DETECTED - Test failed at iteration $$i"; \
68-
echo "Total successful iterations: $$((i-1))/5"; \
69-
echo ""; \
70-
echo "📋 FAILURE DETAILS:"; \
71-
echo "=================================================="; \
72-
if [ -f /tmp/test_output_$$i.log ]; then \
73-
echo "Last 50 lines of test output:"; \
74-
tail -50 /tmp/test_output_$$i.log; \
75-
echo ""; \
76-
echo "Full test output saved to: /tmp/test_output_$$i.log"; \
77-
else \
78-
echo "No test output captured"; \
79-
fi; \
80-
echo "=================================================="; \
81-
break; \
82-
fi; \
83-
done; \
84-
if [ $$failed_iteration -gt 0 ]; then \
85-
exit 1; \
86-
fi; \
87-
end_time=$$(date +%s); \
88-
total_duration=$$((end_time - start_time)); \
89-
avg_time=$$((total_time / success_count)); \
90-
echo ""; \
91-
echo "=================================================="; \
92-
echo "✅ ALL 5 ITERATIONS PASSED - NO FLAKINESS DETECTED"; \
93-
echo "📊 PERFORMANCE SUMMARY:"; \
94-
echo " Total time: $${total_duration}s"; \
95-
echo " Average iteration time: $${avg_time}s"; \
96-
echo " Success rate: 5/5 (100%)"; \
97-
echo "=================================================="
98-
9937
open_coverage:
10038
open coverage/tarpaulin-report.html
10139

10240
.PHONY: docs
10341
docs:
10442
cargo xtask generate-docs
43+
44+
extract_mermaid_svgs:
45+
@./scripts/extract_mermaid_from_markers.sh

0 commit comments

Comments
 (0)