fastapi-cloud-setup-ci - Man Page
fastapi cloud setup-ci – Configures a GitHub Actions workflow for deploying the app on push to the specified branch.
Synopsis
fastapi cloud setup-ci [Options] [PATH]
Options
- --branch, -b TEXT
Branch that triggers deploys (defaults to the repo’s default branch).
- --secrets-only, -s
Provisions token and sets secrets, skips writing the workflow file.
- --dry-run, -d
Prints steps that would be taken without actually performing them.
- --file, -f TEXT
Custom workflow filename (written to .github/workflows/)
- --help, -h
Show a help message and exit.
Arguments
- PATH
Path to the folder containing the app (defaults to current directory).
Examples
# Provisions token, sets secrets, and writes workflow file for the ‘main’ # branch fastapi cloud setup-ci
# Same as above but for the ‘develop’ branch fastapi cloud setup-ci --branch develop
# Only provisions token and sets secrets, does not write workflow file fastapi cloud setup-ci --secrets-only
# Prints the steps that would be taken without performing them fastapi cloud setup-ci --dry-run
# Writes workflow to .github/workflows/ci.yml fastapi cloud setup-ci --file ci.yml
See Also
fastapi-cloud-deploy(1), fastapi-cloud-link(1), fastapi-cloud-login(1), fastapi-cloud-logs(1), fastapi-cloud-logout(1), fastapi-cloud-whoami(1), fastapi-cloud-unlink(1), fastapi-cloud-env(1)
Referenced By
fastapi-cloud(1), fastapi-cloud-deploy(1), fastapi-cloud-env(1), fastapi-cloud-link(1), fastapi-cloud-login(1), fastapi-cloud-logout(1), fastapi-cloud-logs(1), fastapi-cloud-unlink(1), fastapi-cloud-whoami(1).