From ba37ff73acbfeed64156bf3f766e106126752eee Mon Sep 17 00:00:00 2001
From: Niels de Vos <ndevos@ibm.com>
Date: Tue, 7 Nov 2023 15:06:14 +0100
Subject: [PATCH] ci: run `tickgit` after merging a PR in the devel branch

The `tickgit.com` webservice seems to not update itself anymore, but
having a list of TODO's is very useful. Use the tickgit project to
gather the TODO's, bit in a GitHub Workflow.

Developers can also run `make containerized-test TARGET=tickgit` to get
the result locally.

Signed-off-by: Niels de Vos <ndevos@ibm.com>
---
 .github/workflows/tickgit.yaml | 18 ++++++++++++++++++
 Makefile                       |  4 ++++
 scripts/Dockerfile.test        |  1 +
 3 files changed, 23 insertions(+)
 create mode 100644 .github/workflows/tickgit.yaml

diff --git a/.github/workflows/tickgit.yaml b/.github/workflows/tickgit.yaml
new file mode 100644
index 000000000..2b49b48eb
--- /dev/null
+++ b/.github/workflows/tickgit.yaml
@@ -0,0 +1,18 @@
+---
+name: List TODO's
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches:
+      - devel
+
+permissions:
+  contents: read
+
+jobs:
+  tickgit:
+    name: tickgit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: make containerized-test TARGET=tickgit
diff --git a/Makefile b/Makefile
index 11d6a2d3e..0fd0406e4 100644
--- a/Makefile
+++ b/Makefile
@@ -143,6 +143,10 @@ check-env:
 
 codespell:
 	codespell --config scripts/codespell.conf
+
+tickgit:
+	tickgit $(CURDIR)
+
 #
 # commitlint will do a rebase on top of GIT_SINCE when REBASE=1 is passed.
 #
diff --git a/scripts/Dockerfile.test b/scripts/Dockerfile.test
index 4efb764b9..d9d5a7e20 100644
--- a/scripts/Dockerfile.test
+++ b/scripts/Dockerfile.test
@@ -56,6 +56,7 @@ RUN source /build.env \
     && npm install @commitlint/cli@"${COMMITLINT_VERSION}" \
     && popd \
     && git config --global --add safe.directory ${CEPHCSIPATH} \
+    && go install github.com/augmentable-dev/tickgit/cmd/tickgit@latest \
     && true
 
 WORKDIR ${CEPHCSIPATH}