Add "What for?" FAQ

This commit is contained in:
southerntofu 2020-04-28 13:30:26 +02:00
parent 868fe0d80f
commit 85de69aeba
1 changed files with 10 additions and 0 deletions

View File

@ -1,5 +1,15 @@
# FAQ
## What is this for?
forgehook attempts to decouple the tight integration between repository ownership on a forge, and the ability to perform CI/CD tasks such as running tests or deploying an application/website.
Usecase 1: Automatically deploy your website/application from your shell account, without giving a 3rd party CI/CD tool (eg. [drone](https://drone.tildegit.org)) access to your shell.
Usecase 2: Maintain a central repository of files shared by different users. These users subscribe to the repository and run on each update a task to keep their $HOME copy updated. Example: dotfiles, a theme for a website.
Usecase 3: Empower users to run their own automated battery of tests on a repository. One user may wish to run the repository's provided test suite, while some users may need more specific testing for their personal usecase.
## How can i manually trigger update for a repo
If you want to integrate third-party tooling as an unprivileged user (i.e. not an endpoint), you can use the unprivileged `forgehook-trigger` command: