From e59a5a34ff94e4aa837bb7814e9ea73389885021 Mon Sep 17 00:00:00 2001 From: alemi Date: Thu, 15 Feb 2024 04:18:11 +0100 Subject: [PATCH] docs: say that it runs only on .tci branch --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3d97322..f0d8922 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,12 @@ most of my CIs are super simple: `cargo doc; cp * /srv/http/docs/`, configuring just set it as `post-update` hook in your repository and, each time such repository gets updated, tci will: * make sure repo is allowed to run CI: checks said repo git config for `tci.allow == true` + * make sure the branch being updated is `.tci` (customizable in server settings) * create a temp dir (under `/tmp`) with unique name * clone your repository in that dir * change current working directory to be inside your freshly cloned repo - * run `.tci` script (you can change it by setting git config `tci.path`) - * print script's `STDOUT` to console + * run `.tci` script (customizable in repo settings) + * print script's `stdout` and `stderr` to console * delete temporary directory and that's it! could not be simpler