From 87206f75003316b185ac85769d8226501aa4a5bd Mon Sep 17 00:00:00 2001 From: EuAndreh Date: Thu, 8 Dec 2022 21:05:53 -0300 Subject: aux/: Embed files in repository --- Makefile | 19 +++--- aux/.gitignore | 1 + aux/ci/report.sh | 158 ++++++++++++++++++++++++++++++++++++++++++++ aux/lib.sh | 33 +++++++++ aux/tld.txt | 1 + aux/workflow/TODOs.sh | 65 ++++++++++++++++++ aux/workflow/favicon.svg | 62 +++++++++++++++++ aux/workflow/head.html | 2 + aux/workflow/md2html.sh | 87 ++++++++++++++++++++++++ aux/workflow/preamble.md.in | 16 +++++ aux/workflow/style.css | 80 ++++++++++++++++++++++ 11 files changed, 516 insertions(+), 8 deletions(-) create mode 100644 aux/.gitignore create mode 100755 aux/ci/report.sh create mode 100644 aux/lib.sh create mode 100644 aux/tld.txt create mode 100755 aux/workflow/TODOs.sh create mode 100644 aux/workflow/favicon.svg create mode 100644 aux/workflow/head.html create mode 100755 aux/workflow/md2html.sh create mode 100644 aux/workflow/preamble.md.in create mode 100644 aux/workflow/style.css diff --git a/Makefile b/Makefile index f494fc0..5c72514 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,9 @@ .POSIX: -NAME = servers -LIST = ~euandreh/public-inbox@lists.sr.ht -TLD = euandre.org +NAME = servers +LIST_NAME = public-inbox +LIST = ~euandreh/$(LIST_NAME)@lists.sr.ht +SEARCH = https://lists.sr.ht/~euandreh/$(LIST_NAME)?search=%5B$(NAME)%5D +TLD = euandre.org @@ -11,10 +13,11 @@ TLD = euandre.org .in: sed \ - -e 's:@PROJECT_UC@:$(NAME):g' \ - -e 's:@PROJECT@:$(NAME):g' \ - -e 's:@MAILING_LIST@:$(LIST):g' \ - -e 's:@TLD@:$(TLD):g' \ + -e 's|@PROJECT_UC@|$(NAME)|g' \ + -e 's|@PROJECT@|$(NAME)|g' \ + -e 's|@MAILING_LIST@|$(LIST)|g' \ + -e 's|@LIST_SEARCH@|$(SEARCH)|g' \ + -e 's|@TLD@|$(TLD)|g' \ < $< > $@ if [ -x $< ]; then chmod +x $@; fi @@ -27,7 +30,7 @@ check: clean: rm -rf \ - .sentinel/ public/ + .sentinel/ public/ aux/workflow/preamble.md dev-check: check public diff --git a/aux/.gitignore b/aux/.gitignore new file mode 100644 index 0000000..93cad91 --- /dev/null +++ b/aux/.gitignore @@ -0,0 +1 @@ +/workflow/preamble.md diff --git a/aux/ci/report.sh b/aux/ci/report.sh new file mode 100755 index 0000000..21cc54e --- /dev/null +++ b/aux/ci/report.sh @@ -0,0 +1,158 @@ +#!/bin/sh +set -eu + +TLD="$(cat aux/tld.txt)" +. aux/lib.sh + + +usage() { + cat <<-'EOF' + Usage: + aux/ci/report.sh -n NAME -o OUTDIR + aux/ci/report.sh -h + EOF +} + +help() { + cat <<-'EOF' + + + Options: + -n NAME the lowercase name of the project + -o OUTDIR directory where to write the files + -h, --help show this message + + + Generate static HTML files CI report from data stored in git + notes. The metadata about the CI runs are stored in the ref + "refs/notes/ci-data", in the format described by + "aux/ci/run.sh", and the raw logs are stored under the ref + "refs/notes/ci-logs". + + + Examples: + + Generate report for project "myapp" in "public/ci/": + + $ sh aux/ci/report.sh -n myapp -o public/ci + EOF +} + + +for flag in "$@"; do + case "$flag" in + --) + break + ;; + --help) + usage + help + exit + ;; + *) + ;; + esac +done + +while getopts 'n:o:h' flag; do + case "$flag" in + n) + NAME="$OPTARG" + ;; + o) + OUTDIR="$OPTARG" + ;; + h) + usage + help + exit + ;; + *) + usage >&2 + exit 2 + ;; + esac +done +shift $((OPTIND - 1)) + + +eval "$(assert_arg "${NAME:-}" '-n NAME')" +eval "$(assert_arg "${OUTDIR:-}" '-o OUTDIR')" + +PASS='✅' +FAIL='❌' + +mkdir -p "$OUTDIR"/logs "$OUTDIR"/data + +for c in $(git notes list | cut -d' ' -f2); do + DATA="$(git notes --ref=refs/notes/ci-data show "$c")" + FILENAME="$(echo "$DATA" | cut -d' ' -f2)" + echo "$DATA" > "$OUTDIR/data/$FILENAME" + git notes --ref=refs/notes/ci-logs show "$c" \ + > "$OUTDIR/logs/$FILENAME" +done + +{ + cat <<-EOF + + + + + + + + $NAME - CI logs + + + + + + +
+

+ CI logs for + $NAME +

+
    + EOF + + for f in $(find "$OUTDIR/data/" -type f | LANG=C.UTF-8 sort -r); do + DATA="$(cat "$f")" + STATUS="$(echo "$DATA" | cut -d\ -f1)" + FILENAME="$(echo "$DATA" | cut -d\ -f2)" + + if [ "$STATUS" = 0 ]; then + STATUS_MARKER="$PASS" + else + STATUS_MARKER="$FAIL" + fi + + cat <<-EOF +
  1. + $STATUS_MARKER 
    $FILENAME
     +
    2. + EOF + done + + cat <<-EOF +
+
+ + + EOF +} > "$OUTDIR"/index.html.tmp + +mv "$OUTDIR"/index.html.tmp "$OUTDIR"/index.html diff --git a/aux/lib.sh b/aux/lib.sh new file mode 100644 index 0000000..9d183f9 --- /dev/null +++ b/aux/lib.sh @@ -0,0 +1,33 @@ +#!/bin/sh + +assert_arg() { + if [ -z "$1" ]; then + printf 'Missing %s.\n\n' "$2" >&2 + cat <<-'EOF' + usage >&2 + exit 2 + EOF + fi +} + +uuid() { + od -xN20 /dev/urandom | + head -n1 | + awk '{OFS="-"; print $2$3,$4,$5,$6,$7$8$9}' +} + +tmpname() { + echo "${TMPDIR:-/tmp}/uuid-tmpname with spaces.$(uuid)" +} + +mkstemp() { + name="$(tmpname)" + touch "$name" + echo "$name" +} + +mkdtemp() { + name="$(tmpname)" + mkdir "$name" + echo "$name" +} diff --git a/aux/tld.txt b/aux/tld.txt new file mode 100644 index 0000000..058a2d6 --- /dev/null +++ b/aux/tld.txt @@ -0,0 +1 @@ +euandre.org \ No newline at end of file diff --git a/aux/workflow/TODOs.sh b/aux/workflow/TODOs.sh new file mode 100755 index 0000000..8b06d15 --- /dev/null +++ b/aux/workflow/TODOs.sh @@ -0,0 +1,65 @@ +#!/bin/sh +set -eu + +TLD="$(cat aux/tld.txt)" +PROJECT_UC= +while getopts 'n:N:m:o:' flag; do + case "$flag" in + n) + PROJECT="$OPTARG" + ;; + N) + PROJECT_UC="$OPTARG" + ;; + m) + MAILING_LIST="$OPTARG" + ;; + o) + OUTDIR="$OPTARG" + ;; + *) + exit 2 + ;; + esac +done +shift $((OPTIND - 1)) + +assert_arg() { + if [ -z "$1" ]; then + echo "Missing $2" >&2 + exit 2 + fi +} + +assert_arg "${PROJECT:-}" '-n PROJECT' +assert_arg "${MAILING_LIST:-}" '-m MAILING_LIST' +assert_arg "${OUTDIR:-}" '-o OUTDIR' + +if [ -z "${PROJECT_UC:-}" ]; then + PROJECT_UC="$PROJECT" +fi + + +td -H | + cat aux/workflow/preamble.md - | + sed \ + -e "s:@PROJECT_UC@:$PROJECT_UC:g" \ + -e "s:@PROJECT@:$PROJECT:g" \ + -e "s:@MAILING_LIST@:$MAILING_LIST:g" \ + -e "s:@TLD@:$TLD:g" | + pandoc \ + --toc \ + --highlight-style pygments \ + --toc-depth=2 \ + -s \ + --metadata title="$PROJECT_UC - TODOs" \ + --metadata lang=en \ + -r commonmark \ + -w html \ + -H aux/workflow/favicon.html \ + -H aux/workflow/style.css | + sed \ + -e 's:::g' + +# FIXME: check TODOs.sh from euandre.org diff --git a/aux/workflow/favicon.svg b/aux/workflow/favicon.svg new file mode 100644 index 0000000..ce566b2 --- /dev/null +++ b/aux/workflow/favicon.svg @@ -0,0 +1,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/aux/workflow/head.html b/aux/workflow/head.html new file mode 100644 index 0000000..3902690 --- /dev/null +++ b/aux/workflow/head.html @@ -0,0 +1,2 @@ + + diff --git a/aux/workflow/md2html.sh b/aux/workflow/md2html.sh new file mode 100755 index 0000000..957bfc2 --- /dev/null +++ b/aux/workflow/md2html.sh @@ -0,0 +1,87 @@ +#!/bin/sh +set -eu + +. aux/lib.sh + +usage() { + cat <<-'EOF' + Usage: + aux/workflow/md2html.sh -N NAME_UC -T TITLE [-D TOC_DEPTH] < FILE.md + aux/workflow/md2html.sh -h + EOF +} + +help() { + cat <<-'EOF' + + Options: + -N NAME_UC the uppercased name of the project + -T TITLE the required title of the generated HTML + document + -D TOC_DEPTH the depth of the generated table of + contents (default: 2) + -h, --help show this message + + + Read markdown text from STDIN and emit HTML to STDOUT. + EOF +} + +for flag in "$@"; do + case "$flag" in + --) + break + ;; + --help) + usage + help + exit + ;; + *) + ;; + esac +done + +TOC_DEPTH=2 +while getopts 'N:T:D:h' flag; do + case "$flag" in + N) + NAME_UC="$OPTARG" + ;; + T) + TITLE="$OPTARG" + ;; + D) + TOC_DEPTH="$OPTARG" + ;; + h) + usage + help + exit + ;; + *) + usage >&2 + exit 2 + ;; + esac +done +shift $((OPTIND - 1)) + +eval "$(assert_arg "${NAME_UC:-}" '-T TITLE')" +eval "$(assert_arg "${TITLE:-}" '-T TITLE')" + +THE_LANG='en' + +ALTERNATES=/dev/null + +pandoc \ + -s \ + --toc \ + --toc-depth="$TOC_DEPTH" \ + --highlight-style=pygments \ + --metadata lang="$THE_LANG" \ + --metadata title="$TITLE - $NAME_UC" \ + -r commonmark \ + -w html \ + -H aux/workflow/head.html \ + -H "$ALTERNATES" diff --git a/aux/workflow/preamble.md.in b/aux/workflow/preamble.md.in new file mode 100644 index 0000000..1d17997 --- /dev/null +++ b/aux/workflow/preamble.md.in @@ -0,0 +1,16 @@ +# About + +TODOs for [@PROJECT_UC@](https://@TLD@/@PROJECT@/en/). + +Register a new one at +[@MAILING_LIST@](mailto:@MAILING_LIST@?subject=%5B@PROJECT@%5D%20BUG%20or%20TASK%3A%20%3Cdescription%3E) +and see [existing discussions](@LIST_SEARCH@). + +*Você também pode escrever em português*. + +*Vous pouvez aussi écrire en français*. + +*Vi povas ankaŭ skribi esperante*. + +*Tu también puedes escribir en español*. + diff --git a/aux/workflow/style.css b/aux/workflow/style.css new file mode 100644 index 0000000..4f3c83e --- /dev/null +++ b/aux/workflow/style.css @@ -0,0 +1,80 @@ +html { + line-height: 1.5; +} + +body { + max-width: 800px; + margin: 0 auto 0 auto; +} + +hr { + background-color: #ccc; +} + +.header-anchor { + opacity: 0.5; + display: inline-block; +} + +.tag { + font-family: monospace; + font-size: 70%; + background-color: lightgray; + color: black; + padding: 3px; + border-radius: 5px; +} + +.TODO { + color: brown; +} + +.DOING { + color: yellowgreen; +} + +.WAITING, .MEETING { + color: orange; +} + +.INACTIVE { + color: gray; +} + +.NEXT { + color: red; +} + +.CANCELLED, .DONE, .WONTFIX { + color: green; +} + +pre, code { + background-color: #ddd; + border-radius: 5px; + padding: 3px; +} + +pre > code { + overflow: auto; + white-space: pre; +} + +@media(prefers-color-scheme: dark) { + :root { + color: white; + background-color: black; + } + + a { + color: hsl(211, 100%, 60%); + } + + a:visited { + color: hsl(242, 100%, 80%); + } + + pre, code { + background-color: #222; + } +} -- cgit v1.2.3