1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/yunorunner_ynh.git synced 2024-09-03 20:36:13 +02:00

Suggestions from review, improve documentation

This commit is contained in:
tituspijean 2023-07-23 09:02:32 +00:00
parent 1a74c54e84
commit 24d06bc012
4 changed files with 10 additions and 18 deletions

6
doc/POST_INSTALL.md Normal file
View file

@ -0,0 +1,6 @@
If you want to enable Matrix notification, you should look at
the instructions inside `__FINAL_PATH__lib/chat_notify.sh` to deploy matrix-commander.
You may also want to tweak the `__FINAL_PATH__/config.py` file to run test with a different branch or architecture.
When you're ready to start the CI, restart its service via the webadmin or run `systemctl restart __APP__`.

2
doc/PRE_INSTALL.md Normal file
View file

@ -0,0 +1,2 @@
YunoRunner will install LXD, for containers management.
Make sure your system has virtualization capability, and enough resources.

View file

@ -53,7 +53,7 @@
"choices": ["auto", "manual"], "choices": ["auto", "manual"],
"default": "manual", "default": "manual",
"ask": { "ask": {
"en": "Should the jobs be automatically run from the apps list?" "en": "Should the jobs be automatically run from the apps list? In manual mode, Yunorunner will expect to be triggered by the `ciclic` command or webhooks (like ci-apps-dev). In auto mode, all apps of the catalog will be scheduled to be tested at least once a month and upon any change in their designated main branch (like ci-apps)."
} }
}, },
{ {
@ -62,7 +62,7 @@
"choices": ["cluster", "no"], "choices": ["cluster", "no"],
"default": "no", "default": "no",
"ask": { "ask": {
"en": "Should an LXD cluster be created with this server as first node?" "en": "Should an LXD cluster be created with this server as first node? (cluster mode is experimental)"
} }
} }
] ]

View file

@ -121,22 +121,6 @@ function add_cron_jobs() {
EOF EOF
} }
# =========================
# Main stuff
# =========================
# Add permission to the user for the entire yunorunner home because it'll be the one running the tests (as a non-root user)
chown -R $ci_user $YUNORUNNER_HOME
echo "Done!"
echo " "
echo "N.B. : If you want to enable Matrix notification, you should look at "
echo "the instructions inside lib/chat_notify.sh to deploy matrix-commander"
echo ""
echo "You may also want to tweak the 'config' file to run test with a different branch / arch"
echo ""
echo "When you're ready to start the CI, run: systemctl restart $ci_user"
#================================================= #=================================================
# EXPERIMENTAL HELPERS # EXPERIMENTAL HELPERS
#================================================= #=================================================