From f8bee5da04ec0d78b9b6a79f13baa43a20c8bc94 Mon Sep 17 00:00:00 2001
From: Robert Oleynik <robert.oleynik@scalableminds.com>
Date: Thu, 19 Sep 2024 13:34:26 +0200
Subject: [PATCH] fix CI and add Readme

---
 .github/workflows/build-slurm-packages.yml |  8 ++++----
 Readme.md                                  | 13 +++++++++++++
 2 files changed, 17 insertions(+), 4 deletions(-)
 create mode 100644 Readme.md

diff --git a/.github/workflows/build-slurm-packages.yml b/.github/workflows/build-slurm-packages.yml
index aa47053..f171c48 100644
--- a/.github/workflows/build-slurm-packages.yml
+++ b/.github/workflows/build-slurm-packages.yml
@@ -11,18 +11,18 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: "Download Slurm ${{ github.ref_name }}"
-        command: |
+        run: |
           curl https://download.schedmd.com/slurm/slurm-${{ github.ref_name }}.tar.bz2 -o slurm.tar.bz2
       - name: "Unpack Slurm Sources"
-        command: |
+        run: |
           tar -xjvf ./slurm.tar.bz2
       - name: "Build/Install Dependencies"
         working-directory: ./slurm-${{ github.ref_name }}
-        command: |
+        run: |
           yes | mk-build-deps -i debian/control
       - name: "Build Packages"
         working-directory: ./slurm-${{ github.ref_name }}
-        command: |
+        run: |
           debuild -b -uc -us
       - name: "Create Release Artifact"
         uses: softprops/action-gh-releases@v2
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..35b6c1b
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,13 @@
+# Slurm Debian Packages
+
+## Generate New Packages and Dockerimage
+
+Releases are created from tags.
+To create a new release for a new Slurm version run:
+
+```bash
+git tag "<slurm_version>"
+git push --tags
+```
+
+The corresponding packages and image are created using [GitHub Actions](./.github/workflows/build-slurm-packages.yml).