From 4c57f87d9da92b19269ca1954ad4c96b69187c83 Mon Sep 17 00:00:00 2001
From: dehanj <jobson@tillitis.se>
Date: Mon, 12 Feb 2024 19:58:02 +0100
Subject: [PATCH] Upload a zip of SDK with CI

We upload an artifact of the entire device app SDK that can be
directly used as LIBDIR for device apps. It includes all include
files, the libraries, the linker script, and some short documentation.

Retention of the artifact is right now just set to 2 days, so if you
want to make a proper release be sure to copy it.

Co-authored-by: Michael Cardell Widerkrantz <mc@tillitis.se>
---
 .github/workflows/ci.yaml | 16 +++++++++++++++-
 README-DIST.txt           | 40 +++++++++++++++++++++++++++++++++++++++
 tools/spdx-ensure         |  1 +
 3 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 README-DIST.txt

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index b7e76ab..5762b0b 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -16,7 +16,7 @@ jobs:
       image: ghcr.io/tillitis/tkey-builder:2
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           # fetch-depth: 0
           persist-credentials: false
@@ -34,3 +34,17 @@ jobs:
 
       - name: check for SPDX tags
         run: ./tools/spdx-ensure
+
+      - name: Archive
+        uses: actions/upload-artifact@v4
+        with:
+          name: tkey-libs
+          retention-days: 2
+          path: |
+            README-DIST.txt
+            app.lds
+            LICENSE
+            include/*
+            *.a
+            monocypher/*.h
+            monocypher/LICENSE
diff --git a/README-DIST.txt b/README-DIST.txt
new file mode 100644
index 0000000..e4ab5d0
--- /dev/null
+++ b/README-DIST.txt
@@ -0,0 +1,40 @@
+tkey-libs binary distribution
+
+This is the binary distribution of:
+
+  https://github.com/tillitis/tkey-libs
+
+Which is an SDK for developing device apps for the Tillitis TKey in C.
+Please see the TKey Developer Handbook for more:
+
+  https://dev.tillitis.se/
+
+and the company web site:
+
+  https://tillitis.se/
+
+You should be able to use this distribution directly in device apps
+simply by pointing LIBDIR to where you unpacked this archive:
+
+  make LIBDIR=~/Download/tkey-libs
+
+Copyright Tillitis AB.
+
+These programs are free software: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, version 2 only.
+
+These programs are distributed in the hope that they will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see:
+
+  https://www.gnu.org/licenses
+
+See LICENSE for the full GPLv2-only license text.
+
+Note that Monocypher is Copyright Loup Vaillant and released under CC0
+1.0 Universal, see monocypher/LICENSE.
diff --git a/tools/spdx-ensure b/tools/spdx-ensure
index 8d17bae..ed14a11 100755
--- a/tools/spdx-ensure
+++ b/tools/spdx-ensure
@@ -20,6 +20,7 @@ missingok_files=(
 LICENSE
 Makefile
 README.md
+README-DIST.txt
 RELEASE.md
 example-app/Makefile
 monocypher/LICENSE