Standalone app

[jswny]

Rewrite of this repository into a standalone Go command-line application which supports deployment from CI or the command-line.

Closes closes #5, closes #11, closes #13.

Go Implementation

• Parse config file for options
• Get options from environment variables
• Get options from command line as arguments
• Allow nulls from config file
• Allow nulls from environment variables
• Allow nulls from command line arguments
• Merge config file, environment variables, and command line arguments
• Get defaults for options
• Verify options
• Setup SCP connection
• Send files to server
• Look for files recursively beneath the current directory
• Generate .env with environment variables
• Add container name to .env
• Add image specifier to .env
• Send .env to server
• Rename files when sending to server
• Setup SSH connection
• Start app on server

Infrastructure

• Create Go module
• Check Go formatting
• Lint Go code
• Run tests in CI
• Test coverage in CI
• Add GoReleaser action
• Automatically generate binaries for releases with GoReleaser

Other Cleanup

• Update Dockerfile
• Update example Dockerfile
• Update CI workflow
• Ensure CI jobs depend on appropriate jobs
• Remove shell CI steps
• Remove old files
• Use sad-example for repository
• Change app/ to example/ and update references
• Push example image as sad-example

Images

• Login to GHCR
• Push example app images to GHCR
• Use GHCR as deployment registry for example app
• Add Dockerfile
• Push images to GHCR
• Label image with source repository

Documentation

• Building from source
• Installing from binaries (in releases)
• Using action
• File locations
• Remove action specific docs

Inputs and Outputs

Inputs:

• Docker image name
• Docker image digest
• Docker image registry

Outputs:

• Docker image specifier (image name with digest)
• Deployment name (image name with channel)
• Deployment environment variables for injection

Option Parsing Precedence

1. Command line
2. Environment variables
3. Config file