Skip to main content

ci/README.md

1# ci
3This is a collection of scripts that I use for a DIY continuous integration system for my repos.
5Within a bare repo, it's enough to call the `run_post_receive_checks.sh` wrapper, for example:
7```bash
8#!/usr/bin/env bash
10set -o errexit
11set -o nounset
13bash ~/repos/scripts/ci/run_post_receive_checks.sh chives
14```
16## The individual scripts
18<!-- [[[cog
20# This adds the root of the repo to the PATH, which has cog_helpers.py
21from os.path import abspath, dirname
22import sys
24sys.path.append(abspath(dirname(dirname("."))))
26import cog_helpers
28folder_name = "ci"
30scripts = [
31 {
32 "usage": "run_post_receive_checks.sh [REPO_NAME]",
33 "description": """
34 run the post-receive checks for a repo, dumping the output to a file
35 """
36 },
37 {
38 "usage": "post_receive_tests.sh [REPO_NAME]",
39 "description": """
40 run the tests for a repo, printing output to stdout/stderr
41 """
42 },
43 {
44 "usage": "ts",
45 "description": """
46 find the `run_{name}_tests.sh` script in a repo and run it
47 """
48 },
51cog_helpers.create_description_table(folder_name=folder_name, scripts=scripts)
53]]]-->
54<dl>
55 <dt>
56 <a href="https://github.com/alexwlchan/scripts/blob/main/ci/run_post_receive_checks.sh">
57 <code>run_post_receive_checks.sh [REPO_NAME]</code>
58 </a>
59 </dt>
60 <dd>
61 run the post-receive checks for a repo, dumping the output to a file
62 </dd>
64 <dt>
65 <a href="https://github.com/alexwlchan/scripts/blob/main/ci/post_receive_tests.sh">
66 <code>post_receive_tests.sh [REPO_NAME]</code>
67 </a>
68 </dt>
69 <dd>
70 run the tests for a repo, printing output to stdout/stderr
71 </dd>
73 <dt>
74 <a href="https://github.com/alexwlchan/scripts/blob/main/ci/ts">
75 <code>ts</code>
76 </a>
77 </dt>
78 <dd>
79 find the `run_{name}_tests.sh` script in a repo and run it
80 </dd>
81</dl>
82<!-- [[[end]]] (sum: MvYcRvOIeM) -->