aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.github/workflows/docker.yml54
-rw-r--r--.github/workflows/dotnet.yml6
-rw-r--r--.gitignore3
-rw-r--r--Dockerfile7
-rw-r--r--README.md30
-rw-r--r--docs/Docker.md12
-rw-r--r--include/locusts.go10
7 files changed, 119 insertions, 3 deletions
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
new file mode 100644
index 0000000..08d7ba1
--- /dev/null
+++ b/.github/workflows/docker.yml
@@ -0,0 +1,54 @@
+name: Docker
+
+on:
+ push:
+ paths:
+ - "Dockerfile"
+ - "include/locusts.go"
+ pull_request:
+ paths:
+ - "Dockerfile"
+ - "include/locusts.go"
+
+env:
+ REGISTRY: ghcr.io
+ IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+ build-and-push:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v3
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+ - name: Set up Go
+ uses: actions/setup-go@v2
+ with:
+ go-version: 'stable'
+ - name: Set up Tinygo
+ uses: acifani/setup-tinygo@v2
+ with:
+ install-binaryen: 'false'
+ - name: Build the file
+ run: tinygo build -o locusts ./include
+ - name: Extract metadata
+ id: meta
+ uses: docker/metadata-action@v3
+ with:
+ images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+ - name: Login to GitHub Registry
+ uses: docker/login-action@v2
+ with:
+ registry: ${{ env.REGISTRY }}
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+ - name: Build and Push
+ uses: docker/build-push-action@v5
+ with:
+ context: .
+ push: ${{ github.event_name != 'pull_request' }}
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
index c95302a..44b5b7e 100644
--- a/.github/workflows/dotnet.yml
+++ b/.github/workflows/dotnet.yml
@@ -13,7 +13,7 @@ on:
- "**.sln"
jobs:
- build:
+ test:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
@@ -33,7 +33,7 @@ jobs:
run: dotnet test --no-restore
publish-preview:
- needs: build
+ needs: test
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
runs-on: ubuntu-latest
permissions:
@@ -59,7 +59,7 @@ jobs:
run: dotnet nuget push src/bin/Release/*.symbols.nupkg
publish-release:
- needs: build
+ needs: test
if: ${{ github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/') }}
runs-on: ubuntu-latest
steps:
diff --git a/.gitignore b/.gitignore
index 8a20ca9..963f2e8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -810,3 +810,6 @@ $RECYCLE.BIN/
# Vim temporary swap files
*.swp
+
+# Docker
+locusts \ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..c90ac33
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,7 @@
+FROM scratch
+LABEL org.opencontainers.image.licenses=0BSD
+LABEL org.opencontainers.image.source=https://github.com/locusts-r-us/locusts
+LABEL org.opencontainers.image.title=Locusts
+LABEL org.opencontainers.image.description="A container that contains locusts"
+COPY locusts /
+ENTRYPOINT ["/locusts"] \ No newline at end of file
diff --git a/README.md b/README.md
index ca16238..a9a0da6 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,28 @@
We here at Locusts-R-Us have developed a series of libraries for all sorts of programming languages to introduce locusts in all sorts of codebases.
+## FAQ
+
+### Why Locusts?
+
+The punchline of [XKCD 797](https://xkcd.com/797/). (Pictured below)
+
+[![XKCD 797 "DEBIAN-MAIN"](https://imgs.xkcd.com/comics/debian_main.png)](https://xkcd.com/797/)
+
+Including locusts as a dependency in your codebase is probably a terrible idea from a security standpoint, but it's very funny.
+
+### Why would you do this?
+
+It's funny.
+
+### Do any of these libraries serve any purpose?
+
+No.
+
+### How do I add these to my projects?
+
+See the documentation below.
+
## Currently Supported Languages
- [C/C++](./docs/C.md)
@@ -9,3 +31,11 @@ We here at Locusts-R-Us have developed a series of libraries for all sorts of pr
- [Rust](./docs/Rust.md)
- [Python](./docs/Python.md)
- [C#/F#](./docs/.NET.md)
+
+### Not a language but
+
+- [Docker](./docs/Docker.md)
+
+## License
+
+Every locust library in this repository is licensed under the [0 Clause BSD License](./LICENSE).
diff --git a/docs/Docker.md b/docs/Docker.md
new file mode 100644
index 0000000..4647476
--- /dev/null
+++ b/docs/Docker.md
@@ -0,0 +1,12 @@
+# Locusts
+
+A docker container containing locusts also exist.
+
+If you would like to add locusts to your company's servers, you can use the following command:
+
+```bash
+docker run -it --rm ghcr.io/locusts-r-us/locusts:latest
+```
+
+That's it. There are locusts now in your computer.
+What those locusts do is up to the reader.
diff --git a/include/locusts.go b/include/locusts.go
new file mode 100644
index 0000000..957d61a
--- /dev/null
+++ b/include/locusts.go
@@ -0,0 +1,10 @@
+// This exists purely to build the Docker container.
+package main
+
+import (
+ "github.com/locusts-r-us/locusts"
+)
+
+func main() {
+ locusts.IntroduceLocusts()
+}