Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

👀 More featured and bugfixed action #61

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

👀 More featured and bugfixed action #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
c564975
Allow bypassing of pr-number check
JargeZ Jul 19, 2024
704a7e0
Documentation
JargeZ Jul 19, 2024
2c6343f
Pass build-args
JargeZ Jul 20, 2024
8c21c56
All the variables
JargeZ Jul 30, 2024
2815f0b
Remote builder input argument
JargeZ Jul 30, 2024
fdc5687
Draft: attach redis
JargeZ Aug 21, 2024
591afd2
Replace slash
JargeZ Aug 22, 2024
c64761c
Revert "Draft: attach redis"
JargeZ Aug 22, 2024
4d6566e
Make more generic
JargeZ Aug 23, 2024
bd8b0f6
App create and database drop
JargeZ Sep 4, 2024
b6eb54e
Awake postgres machine
JargeZ Sep 10, 2024
2045310
Reset db
JargeZ Oct 25, 2024
160ebec
Revert "Reset db"
JargeZ Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,27 @@ If you have an existing `fly.toml` in your repo, this action will copy it with a

## Inputs

| name | description |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | description |
| ---------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | The name of the Fly app. Alternatively, set the env `FLY_APP`. For safety, must include the PR number. Example: `myapp-pr-${{ github.event.number }}`. Defaults to `pr-{number}-{repo_org}-{repo_name}`. |
| `image` | Optional pre-existing Docker image to use |
| `config` | Optional path to a custom Fly toml config. Config path should be relative to `path` parameter, if specified. |
| `region` | Which Fly region to run the app in. Alternatively, set the env `FLY_REGION`. Defaults to `iad`. |
| `org` | Which Fly organization to launch the app under. Alternatively, set the env `FLY_ORG`. Defaults to `personal`. |
| `path` | Path to run the `flyctl` commands from. Useful if you have an existing `fly.toml` in a subdirectory. |
| `postgres` | Optional name of an existing Postgres cluster to `flyctl postgres attach` to. |
| `update` | Whether or not to update this Fly app when the PR is updated. Default `true`. |
| `secrets` | Secrets to be set on the app. Separate multiple secrets with a space |
| `vmsize` | Set app VM to a named size, eg. shared-cpu-1x, dedicated-cpu-1x, dedicated-cpu-2x etc. Takes precedence over cpu, cpu kind, and memory inputs. |
| `cpu` | Set app VM CPU (defaults to 1 cpu). Default 1. |
| `cpukind` | Set app VM CPU kind - shared or performance. Default shared. |
| `memory` | Set app VM memory in megabytes. Default 256. |
| `ha` | Create spare machines that increases app availability. Default `false`. |
| `image` | Optional pre-existing Docker image to use |
| `config` | Optional path to a custom Fly toml config. Config path should be relative to `path` parameter, if specified. |
| `region` | Which Fly region to run the app in. Alternatively, set the env `FLY_REGION`. Defaults to `iad`. |
| `org` | Which Fly organization to launch the app under. Alternatively, set the env `FLY_ORG`. Defaults to `personal`. |
| `path` | Path to run the `flyctl` commands from. Useful if you have an existing `fly.toml` in a subdirectory. |
| `postgres` | Optional name of an existing Postgres cluster to `flyctl postgres attach` to. |
| `postgres_clean_on_close` | Drop database and role on Pull Request close event (default false) |
| `update` | Whether or not to update this Fly app when the PR is updated. Default `true`. |
| `secrets` | Secrets to be set on the app. Separate multiple secrets with a space |
| `vmsize` | Set app VM to a named size, eg. shared-cpu-1x, dedicated-cpu-1x, dedicated-cpu-2x etc. Takes precedence over cpu, cpu kind, and memory inputs. |
| `cpu` | Set app VM CPU (defaults to 1 cpu). Default 1. |
| `cpukind` | Set app VM CPU kind - shared or performance. Default shared. |
| `memory` | Set app VM memory in megabytes. Default 256. |
| `ha` | Create spare machines that increases app availability. Default `false`. |
| `allow_unsafe_name` | Allow a name that does not contain a PR number. Useful for deploying preview environments across multiple repo with reusable pipelines. Default `false`. |
| `remote_only` | Add --remote-only flag to flyctl deploy command to use remote build. Improve build speed (default false) |
| `build_args` | Optional Docker --build-arg Separate multiple arguments with a space |
| `build_secrets` | Optional Docker --build-secret |

## Required Secrets

Expand Down Expand Up @@ -61,7 +66,7 @@ jobs:

- name: Deploy
id: deploy
uses: superfly/fly-pr-review-apps@1.0.0
uses: superfly/fly-pr-review-apps@1.3.0
```

## Cleaning up GitHub environments
Expand Down
19 changes: 19 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ runs:
inputs:
name:
description: Fly app name
event_action:
description: Event action name
default: ${{ github.event.action }}
required: true
image:
description: Optional pre-existing Docker image to use
config:
Expand All @@ -22,6 +26,9 @@ inputs:
description: path to a directory containing a fly.toml to clone
postgres:
description: Optionally attach the app to a pre-existing Postgres cluster on Fly
postgres_clean_on_close:
description: Drop database and role on Pull Request close event (default false)
default: false
secrets:
description: Secrets to be set on the app. Separate multiple secrets with a space
vmsize:
Expand All @@ -38,3 +45,15 @@ inputs:
ha:
description: Create spare machines that increases app availability (default false)
default: false
allow_unsafe_name:
description: Allow a name that does not contain a PR number. Useful for deploying preview environments across multiple repo with reusable pipelines (default false)
default: false
remote_only:
description: Add --remote-only flag to flyctl deploy command to use remote build. Improve build speed (default false)
default: false
build_args:
description: Optional Docker --build-arg
build_secrets:
description: Optional Docker --build-secret
environment:
description: Optional environment variables to set on the app. Separate multiple env vars with a space
109 changes: 96 additions & 13 deletions entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,51 +14,134 @@ if [ -z "$PR_NUMBER" ]; then
fi

GITHUB_REPOSITORY_NAME=${GITHUB_REPOSITORY#$GITHUB_REPOSITORY_OWNER/}
EVENT_TYPE=$(jq -r .action /github/workflow/event.json)
EVENT_TYPE=$INPUT_EVENT_ACTION

# Default the Fly app name to pr-{number}-{repo_owner}-{repo_name}
app="${INPUT_NAME:-pr-$PR_NUMBER-$GITHUB_REPOSITORY_OWNER-$GITHUB_REPOSITORY_NAME}"
# Change underscores to hyphens.
app="${app//_/-}"
# Change underscores to hyphens and slashes to hyphens.
app=$(echo "$app" | sed 's/_/-/g' | sed 's/\//-/g')
region="${INPUT_REGION:-${FLY_REGION:-iad}}"
org="${INPUT_ORG:-${FLY_ORG:-personal}}"
image="$INPUT_IMAGE"
config="${INPUT_CONFIG:-fly.toml}"
build_args=""
build_secrets=""
runtime_environment=""
database_name="${app/-/_}_pg"
database_role="${app/-/_}_pg"

if ! echo "$app" | grep "$PR_NUMBER"; then
echo "For safety, this action requires the app's name to contain the PR number."
exit 1
if [ "$INPUT_ALLOW_UNSAFE_NAME" != "true" ]; then
echo "For safety, this action requires the app's name to contain the PR number. If you are sure you want to proceed, set the 'allow_unsafe_name' input to 'true'."
exit 1
fi
echo "WARNING: The app's name does not contain the PR number. it is recommended to include the PR number in the app's name."
fi

# PR was closed - remove the Fly app if one exists and exit.
if [ "$EVENT_TYPE" = "closed" ]; then
flyctl apps destroy "$app" -y || true

if [ "$INPUT_POSTGRES_CLEAN_ON_CLOSE" == "true" && -n "$INPUT_POSTGRES" ]; then
flyctl postgres connect --app "$INPUT_POSTGRES" <<EOF || true
drop database ${database_name} with (force );
drop role ${database_role};
\q
EOF
fi

exit 0
fi

#from https://github.com/superfly/fly-pr-review-apps/pull/50
# FIXME spaces, maybe split by \D+=
if [ -n "$INPUT_BUILD_ARGS" ]; then
for ARG in $(echo "$INPUT_BUILD_ARGS" | tr " " "\n"); do
build_args="$build_args --build-arg ${ARG}"
done
fi

if [ -n "$INPUT_BUILD_SECRETS" ]; then
for ARG in $(echo "$INPUT_BUILD_SECRETS" | tr " " "\n"); do
build_secrets="$build_secrets --build-secret ${ARG}"
done
fi

if [ -n "$INPUT_ENVIRONMENT" ]; then
for ARG in $(echo "$INPUT_ENVIRONMENT" | sed 's/\b\(\w\+\)=/\n\1=/g'); do
runtime_environment="$runtime_environment --env ${ARG}"
done
fi

# Deploy the Fly app, creating it first if needed.
if ! flyctl status --app "$app"; then
# Backup the original config file since 'flyctl launch' messes up the [build.args] section
cp "$config" "$config.bak"
flyctl launch --no-deploy --copy-config --name "$app" --image "$image" --region "$region" --org "$org"
# Restore the original config file
cp "$config.bak" "$config"
if [ -n "$INPUT_CONFIG" ]; then
# Config specified explicitly, create empty app
flyctl app create --name "$app" --org "$org"
else
# Default behavior: launch the app inplace from default config
# TODO: https://github.com/superfly/fly-pr-review-apps/issues/49
# Probably dont need to use launch for preview at all or adjust to launch only (handle redis/postgres deletion on destroy)

# Backup the original config file since 'flyctl launch' messes up the [build.args] section
cp "$config" "$config.bak"
flyctl launch --no-deploy --copy-config --name "$app" --image "$image" --region "$region" --org "$org" ${build_args} ${build_secrets} ${runtime_environment}
# Restore the original config file
cp "$config.bak" "$config"
fi
fi
if [ -n "$INPUT_SECRETS" ]; then
echo $INPUT_SECRETS | tr " " "\n" | flyctl secrets import --app "$app"
fi

# Attach postgres cluster to the app if specified.
if [ -n "$INPUT_POSTGRES" ]; then
flyctl postgres attach "$INPUT_POSTGRES" --app "$app" || true
pg_status=$(flyctl postgres list | grep "$INPUT_POSTGRES" | awk '{print $3}')
echo "Postgres status: $pg_status"

if [ "$pg_status" = "suspended" ]; then
echo "Postgres is suspended. Starting it..."
machine_id=$(fly machine list --app "$INPUT_POSTGRES" | tail -n 2 | head -n 1 | awk '{print $1}')
echo "machine_id: $machine_id"
flyctl machine start $machine_id --app "$INPUT_POSTGRES"
fi

# wait for postgres to be deployed
while [ "$pg_status" != "deployed" ]; do
sleep 3
pg_status=$(flyctl postgres list | grep "$INPUT_POSTGRES" | awk '{print $3}')
echo "Postgres status: $pg_status"
if [ "$pg_status" = "deployed" ]; then
# avoid Error: no active leader found
sleep 10
fi
done &
# run loop in background and save pid
pid=$!

# timeout
sleep 120 && kill $pid && echo "Timeout waiting for postgres to deploy" && exit 1 &


# back first job to foreground
fg 1 || true

echo "Postgres status: $pg_status"

flyctl postgres attach "$INPUT_POSTGRES" --app "$app" --database-name "$database_name" --database-user "$database_role" || true
fi

# Use remote builders
if [ -n "$INPUT_REMOTE_ONLY" ]; then
remote_only="--remote-only"
fi

# Trigger the deploy of the new version.
echo "Contents of config $config file: " && cat "$config"
if [ -n "$INPUT_VM" ]; then
flyctl deploy --config "$config" --app "$app" --regions "$region" --image "$image" --strategy immediate --ha=$INPUT_HA --vm-size "$INPUT_VMSIZE"
flyctl deploy --config "$config" --app "$app" --regions "$region" --image "$image" --strategy immediate --ha=$INPUT_HA ${build_args} ${build_secrets} ${runtime_environment} ${remote_only} --vm-size "$INPUT_VMSIZE"
else
flyctl deploy --config "$config" --app "$app" --regions "$region" --image "$image" --strategy immediate --ha=$INPUT_HA --vm-cpu-kind "$INPUT_CPUKIND" --vm-cpus $INPUT_CPU --vm-memory "$INPUT_MEMORY"
flyctl deploy --config "$config" --app "$app" --regions "$region" --image "$image" --strategy immediate --ha=$INPUT_HA ${build_args} ${build_secrets} ${runtime_environment} ${remote_only} --vm-cpu-kind "$INPUT_CPUKIND" --vm-cpus $INPUT_CPU --vm-memory "$INPUT_MEMORY"
fi

# Make some info available to the GitHub workflow.
Expand Down