p
/
acid
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation
Alpine 3.19 Success Details

This commit is contained in:
Přemysl Eric Janouch 2024-04-18 07:10:32 +02:00
parent 4a23c47a92
commit d632111c45
Signed by: p
GPG Key ID: A0420B94F92B9493
2 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.adoc
View File

@ -9,7 +9,7 @@ while the gist of it is actually very simple--run some stuff on new git commits.
'acid' provides a simple web frontend, as well as a webhook endpoint 'acid' provides a simple web frontend, as well as a webhook endpoint
for notifications about new commits. The daemon is supposed to be "firewalled" for notifications about new commits. The daemon is supposed to be "firewalled"
by a normal HTTP server, and it will not provide TLS support to secure by a normal HTTP server, and as such it will not provide TLS support to secure
communications. communications.
'acid' runs tasks over SSH, which should be universal enough. 'acid' runs tasks over SSH, which should be universal enough.
@ -26,6 +26,9 @@ Getting it to work
You will need to write your own runner scripts, which may be nontrivial. You will need to write your own runner scripts, which may be nontrivial.
The author suggests using __cloud-init__-enabled virtual machines with QEMU. The author suggests using __cloud-init__-enabled virtual machines with QEMU.
For a step-by-step guide, see
https://p.janouch.name/text/continuous-integration.html[the related article].
Demo Demo
---- ----
'acid' is deployed on https://git.janouch.name[]. 'acid' is deployed on https://git.janouch.name[].

13
acid.adoc
View File

@ -15,11 +15,14 @@ Synopsis
Description Description
----------- -----------
*acid* run without command arguments will start an HTTP server that creates *acid* run without command arguments will start an HTTP server that creates
and executes tasks upon receiving push notifications from a Gitea instance, and executes tasks against *git*(1) commits from a particular Gitea instance,
according to the passed configuration file. in accordance with the passed configuration file.
When a command is passed, *acid* will relay it to that running instance When a command is passed, *acid* will relay it to that running instance
as an RPC call. of itself as an RPC call.
Tasks can be triggered to run either upon receiving Gitea push events
on the */push* endpoint, and/or using the RPC commands.
Options Options
------- -------
@ -85,3 +88,7 @@ Reporting bugs
-------------- --------------
Use https://git.janouch.name/p/acid to report bugs, request features, Use https://git.janouch.name/p/acid to report bugs, request features,
or submit pull requests. or submit pull requests.
See also
--------
*git*(1), *sh*(1)