Skip to content

Commit 15c9c1e

Browse files
Readme changes
1 parent b60bb57 commit 15c9c1e

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

‎.github/workflows/push_main.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
- main
66

77
env:
8-
SERVICE_NAME: fastapicloudrun
8+
SERVICE_NAME: fastapi-cloud-run
99
REGION: us-central1
1010

1111
jobs:

‎README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A template for deploying a FastAPI application on Google Cloud Run.
1111

1212
### Prerequisites
1313

14-
- Python 3.11+
14+
- Python 3.12+
1515
- Docker
1616

1717
### Run Locally
@@ -42,11 +42,16 @@ Deployment is automated with GitHub Actions, but you'll need to set up a few ite
4242

4343
Set the following secrets in your GitHub repository (do not expose these publicly):
4444

45-
- `ARTIFACTREGISTRY_REPOSITORY`: Name of the repository, e.g., `myrepo`.
45+
- `SERVICE_NAME`: Name of your service, e.g., `fastapi-cloud-run`.
4646
- `GCP_PROJECT_ID`: Your project ID, e.g., `9876543210`.
4747
- `GCP_WIF_PROVIDER`: Your Workload Identity Federation provider full name, formatted as `projects/${PROJECT_ID}/locations/global/workloadIdentityPools/${POOL_NAME}/providers/${PROVIDER_NAME}`.
4848
- `GCP_WIF_SA_EMAIL`: Service account email to impersonate.
4949

50+
The deployment workflow will:
51+
1. Run Ruff checks for code quality
52+
2. Build and push the Docker image to Google Artifact Registry
53+
3. Deploy the service to Cloud Run in the specified region
54+
5055
Refer to `.github/workflows/push_main.yml` for more details on the deployment process.
5156

5257
## License

0 commit comments

Comments
 (0)