Merge pull request #258 from earthly/main

Make disposable-email list reference-able from Earthly builds
MISP · Nov 27, 2023 · 7d011e4 · 7d011e4
2 parents b777197 + fb23389
commit 7d011e4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/Earthfile b/Earthfile
@@ -0,0 +1,6 @@
+VERSION 0.7
+FROM alpine:3.18.4
+
+export-lists:
+    COPY --dir lists ./
+    SAVE ARTIFACT lists
diff --git a/README.md b/README.md
@@ -133,6 +133,13 @@ If matching_attributes are not set, the list is matched against any type of attr
 See [PyMISPWarningLists](https://github.com/MISP/PyMISPWarningLists) for a
 python interface to warning lists.
 
+# Using warning lists in Earthly builds
+
+Lists are exposed to [Earthly](https://github.com/earthly/earthly) builds through the target `export-lists`. Earthfiles can directly reference them in their copy statements as follows:
+```earthly
+COPY github.com/MISP/misp-warninglists[:commit]+export-lists/lists/<list-name>/list.json ./
+```
+
 # License
 
 MISP warning-lists are licensed under [CC0 1.0 Universal (CC0 1.0)](https://creativecommons.org/publicdomain/zero/1.0/) -  Public Domain Dedication. If a specific author of a warning-list (or associated source) wants to license it under a different license, a pull request can be requested.