aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDiederick de Vries <diederick76@users.noreply.github.com>2017-05-05 23:07:53 +0200
committerGitHub <noreply@github.com>2017-05-05 23:07:53 +0200
commita48160763368258ea461bae125c89b535ef52155 (patch)
tree18a039932caf1c9b766ce218c2b7d7f496f43191
parent7ea66e386aeb9b152bdee84f8ef3f06f1fb05b4c (diff)
downloadaside-a48160763368258ea461bae125c89b535ef52155.tar.gz
aside-a48160763368258ea461bae125c89b535ef52155.tar.bz2
aside-a48160763368258ea461bae125c89b535ef52155.zip
Update README.md
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index d7630db..608e58a 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,12 @@ ASiDe (A Simple Deployment pipeline) is a Continuous Integration and Deployment
4 4
5When the applied build script contains the needed test, build and deployment steps, all that is needed is a push to a master branch to release the new version of your project. Logs can be followed or emailed to the user afterwards. 5When the applied build script contains the needed test, build and deployment steps, all that is needed is a push to a master branch to release the new version of your project. Logs can be followed or emailed to the user afterwards.
6 6
7ASiDe consists of the following parts: 7ASiDe consists of the following parts (replace projectname with the name of your project):
8 8
9* A systemd-unit for turning the build trigger on or off: `/etc/systemd/system/aside.service` 9* A systemd-unit for turning the build trigger on or off: `/etc/systemd/system/aside.service`
10* A monitoring script using `inotify(7)` to monitor which triggers appear in `/home/builduser/trigger/`: `/home/builduser/bin/monitor` 10* A monitoring script using `inotify(7)` to monitor which triggers appear in `/home/builduser/trigger/`: `/home/builduser/bin/monitor`
11* A post-update hook in each git repository: `/srv/git/&lt;projectname.git&gt;/hooks/post-update` 11* A post-update hook in each git repository: `/srv/git/projectname.git/hooks/post-update`
12* Build scripts which are triggered by the monitor script: `/var/home/builduser/&lt;projectname&gt;/bin/build` 12* Build scripts which are triggered by the monitor script: `/var/home/builduser/projectname/bin/build`
13 13
14# Flow 14# Flow
15 15
@@ -20,8 +20,8 @@ Deploying is done by a dedicated user `builduser`. Its home `/var/home/builduser
20 builduser/ 20 builduser/
21 bin/monitor 21 bin/monitor
22 trigger/ 22 trigger/
23 <projectname> 23 projectname
24 <projectname>/ 24 projectname/
25 bin/build 25 bin/build
26 resources/ 26 resources/
27 test/ 27 test/
@@ -34,7 +34,7 @@ When the systemd-unit is enabled, it is started by booting the build server. The
34 34
351. A developer pushes a change to `origin/master`. 351. A developer pushes a change to `origin/master`.
362. The post-update hook checkt that the branch is `master`. 362. The post-update hook checkt that the branch is `master`.
373. The post-update hook clones the repository to `/var/home/builduser/&lt;repo&gt;work/`. 373. The post-update hook clones the repository to `/var/home/builduser/projectname/work/`.
384. The post-update hook creates an empty file with the name of the repository in `/var/home/builduser/trigger/` and deletes it immediately. 384. The post-update hook creates an empty file with the name of the repository in `/var/home/builduser/trigger/` and deletes it immediately.
395. The monitoring script notices the trigger and starts the build script in the repository with the name of the trigger. 395. The monitoring script notices the trigger and starts the build script in the repository with the name of the trigger.
406. Afterwards is emails the build script's output to the developer. 406. Afterwards is emails the build script's output to the developer.