init

docs/drist.md

@@ -0,0 +1,41 @@
+# Drist CI documentation
+
+[Drist](https://dataswamp.org/~solene/2019-02-18-drist-1.04.html) is used to deploy files on servers using SSH.
+
+This workflow executes `drist -s hosts` in the current revision.
+
+It runs ssh client with `-o StrictHostKeychecking=no`.
+
+If there's a `ssh_config` file in the repo's root, it will be used to connect to servers. Example:
+
+```
+Host myserver.mycompany.mydomain
+  Port 123
+```
+
+- in `hosts` file, each host should be specified as `user@host`
+- `script` file contains CI script which is executed on each host
+- `script-hostname` file contains CI script which is executed on the specified hostname
+- files from the `files` directory can be accessed from the `script`
+- files from the `files-hostname` directory can be accessed only on the host with specified hostname
+
+How to use:
+
+```yaml
+name: Drist
+on:
+  push:
+    branches:
+      - master
+      - main
+  workflow_dispatch: {}
+
+jobs:
+  drist:
+    name: Run Drist
+    uses: public/ci-templates/.gitea/workflows/drist.yaml@v1
+    secrets:
+      ssh_private_key: ${{ secrets.DRIST_SSH_PRIVATE_KEY }}
+```
+
+There are also inputs that contain default values. You can look them up in [drist.yaml](/.gitea/workflows/drist.yaml)