Skip to content

Commit 8a588c7

Browse files
committed
Better task descriptions
1 parent d0aee37 commit 8a588c7

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

Taskfile.yml

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,20 @@ silent: true
33

44
tasks:
55
default:
6-
desc: The default task that shows help
6+
desc: List available tasks
77
cmds:
8-
- task --list
8+
- echo "Available tasks:"
9+
- echo "task install - Install OS2BorgerPC Adminsite"
10+
- echo "task upgrade - Upgrade OS2BorgerPC Adminsite to a newer version"
11+
- echo "task start - Start the application by bringing all containers up"
12+
- echo "task stop - Stop the application by stopping all containers"
13+
- echo "task reinstall - Reinstall the application. WARNING Deletes volumes and containers"
14+
- echo "task down - Remove the application. Deletes all volumes and containers"
15+
- echo "task cron - Run cron jobs manually"
16+
- echo "task backup_db - Perform a database dump"
917

1018
install:
11-
desc: Install the project
19+
desc: Install OS2BorgerPC Adminsite
1220
cmds:
1321
- task _show_preinstall_notes
1422
- task _version_file
@@ -19,7 +27,7 @@ tasks:
1927
- task _show_notes
2028

2129
upgrade:
22-
desc: Upgrades the admin site to a newer version
30+
desc: Upgrade OS2BorgerPC Adminsite to a newer version
2331
cmds:
2432
- task _show_upgrade_notes
2533
- task _version_file
@@ -30,14 +38,14 @@ tasks:
3038
- task _show_notes
3139

3240
reinstall:
33-
desc: Reinstall from scratch. Removes the database, all containers, and volumes.
41+
desc: Reinstall the application. WARNING Deletes volumes and containers
3442
deps:
3543
- down
3644
cmds:
3745
- task install
3846

3947
down:
40-
desc: Remove all containers and volumes
48+
desc: Remove the application. Deletes all volumes and containers
4149
deps:
4250
- stop
4351
cmds:
@@ -48,18 +56,18 @@ tasks:
4856
echo "VERSION file deleted."
4957
fi
5058
51-
up:
52-
desc: Take the environment up without altering the existing state of the containers
59+
start:
60+
desc: Start the application by bringing all containers up
5361
cmds:
5462
- docker compose --env-file .env -f compose.yml up -d
5563

5664
stop:
57-
desc: Stop all containers without altering anything else
65+
desc: Stop the application by stopping all containers
5866
cmds:
5967
- docker compose --env-file .env -f compose.yml stop
6068

6169
cron:
62-
desc: Manually run all necessary cron jobs, and get automation suggestions
70+
desc: Run cron jobs manually
6371
cmds:
6472
- |
6573
DOMAIN=$(grep ^DOMAIN= .env | cut -d '=' -f 2)
@@ -82,7 +90,7 @@ tasks:
8290
echo "===================================================="
8391
8492
backup_db:
85-
desc: Perform a database dump and save it to the host filesystem
93+
desc: Perform a database dump
8694
cmds:
8795
- |
8896
TIMESTAMP=$(date +%Y%m%d_%H%M%S)

0 commit comments

Comments
 (0)