From 8c1261cda51472df197c9bebfeec0e395a49d0dc Mon Sep 17 00:00:00 2001 From: Louie S Date: Wed, 10 Jul 2024 16:03:34 -0400 Subject: Create README for actions --- actions/Makefile.am | 2 +- actions/README.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 actions/README.md 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= if set to yes, do not remove the podman container after finishing (default is no) +``` -- cgit