summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLouie S <louie@example.com>2024-07-10 16:03:34 -0400
committerLouie S <louie@example.com>2024-07-10 16:03:34 -0400
commit8c1261cda51472df197c9bebfeec0e395a49d0dc (patch)
tree3003c3b6f5b6fce84512a0ac86bc4aa00b1f3129
parent2705958dc6de68a487597e29d4b9b99ccc6724a0 (diff)
Create README for actions
-rw-r--r--actions/Makefile.am2
-rw-r--r--actions/README.md17
2 files changed, 18 insertions, 1 deletions
diff --git a/actions/Makefile.am b/actions/Makefile.am
index a27b73d..6ce9ec2 100644
--- a/actions/Makefile.am
+++ b/actions/Makefile.am
@@ -20,4 +20,4 @@ actions_build_deb: ../$(PACKAGE_NAME)-$(PACKAGE_VERSION).tar.gz
podman exec -w /tmp/build "$(CONTAINER_NAME)" debmake -y -a $(PACKAGE_NAME)-$(PACKAGE_VERSION).tar.gz -i debuild $(DEBUILD_ARGS)
mkdir -p "build/$@/$(IMAGE_NAME)-$(IMAGE_VERSION)"
podman cp "$(CONTAINER_NAME)":/tmp/build/. "build/$@/$(IMAGE_NAME)-$(IMAGE_VERSION)/"
- test "$(SAVE_CONTAINER)" = "no" && (podman kill "$(CONTAINER_NAME)" && podman rm "$(CONTAINER_NAME)")
+ if [ "$(SAVE_CONTAINER)" = "no" ]; then podman kill "$(CONTAINER_NAME)" && podman rm "$(CONTAINER_NAME)"; fi
diff --git a/actions/README.md b/actions/README.md
new file mode 100644
index 0000000..08a1ae0
--- /dev/null
+++ b/actions/README.md
@@ -0,0 +1,17 @@
+### Actions
+
+The action targets are designed to automate testing and package building using containerization (via podman). Before running any actions, ensure that `make dist` has been run in the project root.
+
+```
+Usage: make TARGET [OPTIONS]
+
+targets:
+ actions_build_deb build a deb package
+
+options:
+ CONTAINER_NAME=... specify a container name
+ DEBUILD_ARGS =... call debuild with additional arguments
+ IMAGE_NAME =... build container from a specific image (must also set IMAGE_VERSION)
+ IMAGE_VERSION =... build container from a specific image version (must also set IMAGE_NAME)
+ SAVE_CONTAINER=<yes/no> if set to yes, do not remove the podman container after finishing (default is no)
+```