Skip to content

Commit c9bbc1d

Browse files
committed
refactor(Makefile): 重构 Makefile 命令并更新文档
- 将 `smoke-ci` 命令重命名为 `check` 以更准确描述其功能 - 更新 README.md 和 Makefile 中的命令描述 - 移除不再使用的 SMOKE_PORT 变量
1 parent ad38d2f commit c9bbc1d

2 files changed

Lines changed: 17 additions & 19 deletions

File tree

Makefile

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: start stop restart status smoke smoke-ci clean help
1+
.PHONY: start stop restart status smoke check clean help
22

33
.DEFAULT_GOAL := help
44

@@ -7,8 +7,6 @@ PID_DIR := tmp/pids
77
PID_FILE := $(PID_DIR)/everydocs.pid
88
LOG_DIR := log
99

10-
SMOKE_PORT := $(shell awk 'BEGIN{srand(); print int(1024 + rand() * 54531)}')
11-
1210
help:
1311
@echo "EveryDocs Core - Make Commands"
1412
@echo "=============================================="
@@ -18,8 +16,8 @@ help:
1816
@echo " stop - Stop the EveryDocs server"
1917
@echo " restart - Restart the EveryDocs server"
2018
@echo " status - Check server status"
21-
@echo " smoke - Run interactive smoke test"
22-
@echo " smoke-ci - Run CI smoke test (start -> probe -> stop)"
19+
@echo " smoke - Run smoke test (start -> probe /version -> stop)"
20+
@echo " check - Run quick check (.env + dependencies + tests)"
2321
@echo " test - Run Rails tests"
2422
@echo " logs - Tail the server logs"
2523
@echo " clean-logs - Clean log files"
@@ -34,8 +32,8 @@ help:
3432
@echo "Examples:"
3533
@echo " make start"
3634
@echo " make stop"
37-
@echo " make restart"
38-
@echo " make smoke-ci"
35+
@echo " make smoke"
36+
@echo " make check"
3937
@echo ""
4038

4139
start:
@@ -81,8 +79,11 @@ db-migrate-test:
8179
@cd $(PROJECT_DIR) && rails db:migrate RAILS_ENV=test
8280

8381
smoke:
82+
@cd $(PROJECT_DIR) && ./smoke-ci.sh
83+
84+
check:
8485
@echo "=============================================="
85-
@echo "EveryDocs Core - Interactive Smoke Test"
86+
@echo "EveryDocs Core - Quick Check"
8687
@echo "=============================================="
8788
@echo ""
8889
@echo "Phase 1: Checking prerequisites..."
@@ -121,8 +122,5 @@ smoke:
121122
@echo ""
122123

123124
@echo "=============================================="
124-
@echo "Smoke Test Completed"
125+
@echo "Quick Check Completed"
125126
@echo "=============================================="
126-
127-
smoke-ci:
128-
@cd $(PROJECT_DIR) && ./smoke-ci.sh

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ A `Makefile` is provided for convenience:
190190
| `make stop` | Stop the server |
191191
| `make restart` | Restart the server |
192192
| `make status` | Check server status |
193-
| `make smoke` | Run interactive smoke test |
194-
| `make smoke-ci` | Run CI smoke test (start → probe /version → stop) |
193+
| `make smoke` | Run smoke test (start → probe /version → stop) |
194+
| `make check` | Run quick check (.env + dependencies + tests) |
195195
| `make test` | Run Rails tests |
196196
| `make test-controllers` | Run controller tests only |
197197
| `make logs` | Tail log files |
@@ -383,7 +383,7 @@ A dedicated CI smoke test script is provided to verify the server can actually s
383383
./smoke-ci.sh
384384

385385
# Or via Makefile
386-
make smoke-ci
386+
make smoke
387387
```
388388

389389
This script performs:
@@ -399,14 +399,14 @@ This script performs:
399399
**Features:**
400400
- Random port to avoid conflicts
401401
- Automatic cleanup on exit (via `trap`)
402-
- Tail last 100 lines of logs on failure for debugging
402+
- Tail last 100 lines of logs (`log/everydocs.log` and `log/everydocs.error.log`) on failure for debugging
403403

404-
### Interactive Smoke Test (`make smoke`)
404+
### Quick Check (`make check`)
405405

406-
The interactive smoke test (requires `.env` file):
406+
The quick check (requires `.env` file):
407407

408408
```bash
409-
make smoke
409+
make check
410410
```
411411

412412
This command performs:

0 commit comments

Comments
 (0)