docs: say that it runs only on .tci branch

This commit is contained in:
əlemi 2024-02-15 04:18:11 +01:00
parent 7e1fd5fe3e
commit e59a5a34ff
Signed by: alemi
GPG key ID: A4895B84D311642C

View file

@ -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