initial commit

Signed-off-by: 20k-ultra <3946250+20k-ultra@users.noreply.github.com>

Author: 20k-ultra

README.md

@@ -1 +1,89 @@
-## GitHub Action for Lagon
+# Lagon Action
+
+Easily integrate [Lagon](https://lagon.dev) CLI into your Github workflows. Deploy new functions, retrieve a list of existing functions, promote functions, etc. This action supports any [arbitrary input](#other-commands) of what to do!
+
+## Usage
+
+Create the following workflow in your function's repository:
+
+_./github/workflows/lagon.yml_
+
+```yml
+name: Lagon
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - uses: actions/checkout@v2
+      - uses: lagonapp/github-action@main
+        with:
+          lagon_token: ${{ secrets.LAGON_API_TOKEN }}
+```
+
+This will deploy your source code to the specified function after a commit is pushed into main.
+
+_NOTE: Make sure the repository that gets checked out contains a `.lagon/config.json` file that specifies information such as the function_id and organization_id!_
+
+#### Other commands
+
+If you want to run a different command just specify it with the `command` input:
+
+```bash
+        with:
+          lagon_token: ${{ secrets.LAGON_API_TOKEN }}
+          command: "promote claxnlc230738q5pa7iximskm ./my-project"
+```
+
+See [CLI](https://docs.lagon.app/cli) docs for more commands.
+
+## Inputs
+
+Inputs are provided using the `with:` section of your workflow YML file.
+
+| key         | Description                  | Required | Default                |
+| ----------- | ---------------------------- | -------- | ---------------------- |
+| lagon_token | Your Lagon API token         | true     |                        |
+| command     | The Lagon CLI command to run | false    | deploy --prod          |
+| site_url    | Specify Lagon API domain     | false    | https://dash.lagon.app |
+
+`site_url` is used to specify a custom endpoint if you are using a self-hosted instance of Lagon.
+
+## Outputs
+
+| key | Description | Nullable |
+| --- | ----------- | -------- |
+|     |             |          |
+
+No outputs for now... not sure what the CLI can output, function hash ?
+
+## Developing
+
+Install [act](https://github.com/nektos/act) then push your action changes to a branch on Github if you want to test the changes you made. Unfortunately, you have to push your changes to Github for this test runner to work.
+
+**Make sure to export `LAGON_API_TOKEN` so the action can configure the CLI! This is normally populated by Github.**
+
+Once you have pushed the changes you want to test you can now run it locally with the provided [test.sh](/test.sh) script like so:
+
+```bash
+# Usage: ./test.sh -f path_to_function [-r repo, -c command, -s site_url]
+
+# Test the main branch with a local function project
+./test.sh -f ~/Projects/lagon-function
+
+# Test a development branch
+./test.sh -r lagonapp/github-action@my-dev-branch -f ~/Projects/lagon-function
+
+# You can also specify the command and site_url
+# See the inputs table for more info on the commands
+./test.sh -r lagonapp/github-action@my-dev-branch \
+  -f ~/Projects/lagon-function \
+  -c "ls" \
+  -s "https://lagon.mysite.io"
+```

action.yml

@@ -0,0 +1,42 @@
+name: "Lagon CLI"
+description: "Easily integrate Lagon CLI operations into your Github workflow"
+branding:
+  icon: code
+  color: blue
+inputs:
+  lagon_token:
+    description: "Your Lagon API token"
+    required: true
+  command:
+    description: "The Lagon CLI command to run"
+    required: false
+    default: "deploy --prod"
+  site_url:
+    description: "Specify custom url for self-hosted Lagon instances"
+    required: false
+    default: "https://dash.lagon.app"
+runs:
+  using: "composite"
+  steps:
+    - name: "Install Node.js"
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18
+        cache: npm
+
+    - name: "Install CLI"
+      run: npm install --global @lagon/cli esbuild
+
+    - name: "Execute CLI"
+      env:
+        LAGON_TOKEN: ${{ inputs.lagon_token }}
+        LAGON_COMMAND: ${{ inputs.command }}
+        LAGON_URL: ${{ inputs.site_url }}
+      shell: bash
+      run: |
+        # Setup config folder
+        mkdir -p ~/.lagon
+        # Setup auth
+        echo \{\"token\":\""${LAGON_TOKEN}"\",\"site_url\":\""${LAGON_URL}"\"\} >~/.lagon/config.json
+        # Run CLI
+        eval lagon "$LAGON_COMMAND"

test.sh

@@ -0,0 +1,85 @@
+#!/bin/bash
+set -euo pipefail
+
+function cleanup {
+	if [[ -n "${test_dir+x}" ]]; then
+		rm -rf "$test_dir"
+	fi
+}
+
+# Register the cleanup function to run on exit or interrupt
+trap cleanup EXIT INT
+
+command="deploy --prod"
+site_url="https://dash.lagon.app"
+action_repo="lagonapp/github-action@main"
+function_path=
+
+# Parse inputs
+while getopts ":c:s:r:f:" opt; do
+	case $opt in
+	c)
+		# Optional set the `command` input
+		command="$OPTARG"
+		;;
+	s)
+		# Optionally set the `site_url` input
+		site_url="$OPTARG"
+		;;
+	r)
+		# This tells act which lagon-action to run
+		action_repo="$OPTARG"
+		;;
+	f)
+		# This is the folder that the action will run with (build and deploy)
+		function_path="$OPTARG"
+		;;
+	\?)
+		echo "Invalid option -$OPTARG" >&2
+		;;
+	esac
+done
+
+# Check that required options are set
+if [ -z "$function_path" ]; then
+	echo "Usage: $0 -f path_to_function [-r repo, -c command, -s site_url]" >&2
+	exit 1
+fi
+
+if ! [ -v LAGON_API_TOKEN ]; then
+	echo "You need to export LAGON_API_TOKEN so the action can authenticate the CLI!" >&2
+	exit 1
+fi
+#
+# Make sure the specified directory exists
+if [ ! -d "$function_path" ]; then
+	echo "Directory '$function_path' does not exist" >&2
+	exit 1
+fi
+
+# Make sure the project is a git repo since act will fail
+if [ ! -d "$function_path/.git" ]; then
+	echo "Project '$function_path' must be a git initialized repository" >&2
+	exit 1
+fi
+
+# Create test directory to simulate a repository
+test_dir="/tmp/lagon-action-tester"
+mkdir -p "$test_dir"
+# Create a modified copy of the workflow_test.yml file using the provided repo url
+sed "s!_ACTION_REPO_!$action_repo!g" "$(pwd)/workflow_test.yml" >"$test_dir/test.yml"
+# Symlink project's .git folder so the checkout step works
+ln -sn "$function_path/.git" "$test_dir/.git"
+
+# Clear action cache so new changes are always picked up
+rm -r ~/.cache/act/"$(echo "$action_repo" | sed 's/\//-/g')"
+
+printf "Config: {\n action: \"%s\",\n function_source: \"%s\",\n command: \"%s\",\n site_url: \"%s\"\n}\n" "$action_repo" "$function_path" "$command" "$site_url"
+# run the test workflow with the workflow_dispatch event in the simulated repo (test_dir) and specify a lagon secret.
+# The secret is otherwise set by github when the workflow runs.
+if ! act --input COMMAND="$command" --input SITE_URL="$site_url" workflow_dispatch -C "$test_dir" -W test.yml -s "LAGON_API_TOKEN=$LAGON_API_TOKEN"; then
+	exit $?
+fi
+
+# Clean up the test directory
+cleanup

workflow_test.yml

@@ -0,0 +1,21 @@
+name: lagon
+
+on:
+  workflow_dispatch:
+    inputs:
+      command:
+        required: true
+      site_url:
+        required: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - uses: actions/checkout@v2
+      - uses: _ACTION_REPO_ # This gets updated by the test.sh script
+        with:
+          lagon_token: ${{ secrets.LAGON_API_TOKEN }}
+          command: ${{ github.event.inputs.command }} # github.event.inputs is only for workflow_dispatch events
+          site_url: ${{ github.event.inputs.site_url }} # github.event.inputs is only for workflow_dispatch events