From e344f6c6245fe1121976b407a989af86c7453dad Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Wed, 17 Jun 2020 23:45:48 -0400 Subject: Extracted checks into a tools directory. Having the checks duplicated between .git-hooks and .travis.yml was a recipe for them to diverge eventually. This is somewhat tidier, and creates a clear convention for any future tools-like scripts. I didn't do the same to install steps, as they're a lot more sensitive to the specific environment - Travis requires different things from Github, which requires different things from CircleCI, which requires different things from a local environment. --- tools/README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 tools/README.md (limited to 'tools/README.md') diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000..8c1b7e0 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,26 @@ +# Local Tools + +The scripts in this directory assume they will be run from the root of the +project, as `tools/NAME`. They contain brief, branch-free, composable scripts +intended to be run to achieve frequent goals. They act as a shared shell +history, of a sorts, and as a place to put command-line-ish code that needs to +be shared by multiple components. + +Each script begins with a brief comment demonstrating the intended invocation +and the effects. + +## Authoring + +Tools _should_ begin with a shebang or shell `set` expression that enables +exiting on failure and that enables command echoing, followed by a documentation +comment: + +```bash +#!/bin/bash -ex + +# tools/my-example-tool +# +# Runs all example tasks. + +: … +``` -- cgit v1.2.3