generated from worldbank/template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update adding staging mechanism * Add CD pipeline * Solve f-string matching * Update event to push on main * Add dev CD * Remove npm and node specific jobs * Update variables * Update environment * Update role * Remove cdk bootstrap * Add working directory for cdk deployment * Add cdk requirements * Update cdk requirements * Update deployment variables * Refactor deployment tooling (#85) * Migrate to reusable workflow * Add tooling for PR preview URL * Add runs-on * Pre-commit * Refactor triggers * Bump version * Add permissions * Fix working dir * Fix URL output * Fix comment find * Add tooling to tear down PR preview * Fix commenting * Fix * Run tests on all pushes * Refactor * Fix * Expand events * Fix destroy * Prevent unnecessary deployments * Pass in PR number * Prevent testing on closed PRs * Refactor * Mv to workflows * Fix destroy * Rework trigger * Refine * Rm old needs * Rework trigger * Try fix if condition * Mv deployment trigger back to ci.yml * Rework triggers * Rename jobs * Set concurrency to stage * Only trigger on pushes to main --------- Co-authored-by: Anthony Lukach <anthonylukach@gmail.com>
- Loading branch information
Showing
7 changed files
with
263 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,75 @@ | ||
name: Run Tests | ||
name: "Run Tests" | ||
|
||
on: [push, pull_request] | ||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
types: | ||
- opened | ||
- synchronize | ||
- reopened | ||
- closed | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: 3.11 | ||
|
||
- name: Install Poetry | ||
run: | | ||
python -m pip install --upgrade pip | ||
python -m pip install poetry | ||
- name: Install dependencies | ||
working-directory: ./space2stats_api/src | ||
run: | | ||
poetry install --with test | ||
- name: install lib postgres | ||
uses: nyurik/action-setup-postgis@v2 | ||
|
||
- name: Run pre-commit | ||
working-directory: ./space2stats_api/src | ||
run: | | ||
poetry run pre-commit run --all-files | ||
- name: Run tests | ||
working-directory: ./space2stats_api/src | ||
run: | | ||
poetry run python -m pytest --benchmark-skip tests | ||
env: | ||
PGHOST: localhost | ||
PGPORT: 5432 | ||
PGDATABASE: mydatabase | ||
PGUSER: myuser | ||
PGPASSWORD: mypassword | ||
PGTABLENAME: space2stats | ||
S3_BUCKET_NAME: test-bucket | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: 3.11 | ||
|
||
- name: Install Poetry | ||
run: | | ||
python -m pip install --upgrade pip | ||
python -m pip install poetry | ||
- name: Install dependencies | ||
working-directory: ./space2stats_api/src | ||
run: | | ||
poetry install --with test | ||
- name: install lib postgres | ||
uses: nyurik/action-setup-postgis@v2 | ||
|
||
- name: Run pre-commit | ||
working-directory: ./space2stats_api/src | ||
run: | | ||
poetry run pre-commit run --all-files | ||
- name: Run tests | ||
working-directory: ./space2stats_api/src | ||
run: | | ||
poetry run python -m pytest --benchmark-skip tests | ||
env: | ||
PGHOST: localhost | ||
PGPORT: 5432 | ||
PGDATABASE: mydatabase | ||
PGUSER: myuser | ||
PGPASSWORD: mypassword | ||
PGTABLENAME: space2stats | ||
S3_BUCKET_NAME: test-bucket | ||
|
||
deploy-to-dev: | ||
if: ${{ github.event_name == 'pull_request' }} | ||
needs: test | ||
uses: "./.github/workflows/reusable-deploy.yml" | ||
with: | ||
environment: Space2Stats API Dev | ||
stage: pr-${{ github.event.pull_request.number }} | ||
pr-number: ${{ github.event.pull_request.number }} | ||
secrets: inherit | ||
|
||
deploy-to-production: | ||
if: ${{ github.event_name == 'push' && github.ref_name == 'main' }} | ||
needs: test | ||
uses: "./.github/workflows/reusable-deploy.yml" | ||
with: | ||
environment: Space2Stats API Prod | ||
stage: prod | ||
secrets: inherit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
name: Destroy Preview Environment | ||
|
||
on: | ||
pull_request: | ||
types: | ||
- closed | ||
|
||
permissions: | ||
id-token: write | ||
contents: read | ||
pull-requests: write | ||
|
||
jobs: | ||
destroy: | ||
concurrency: Space2Stats API Dev | ||
environment: Space2Stats API Dev | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Check out repository code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Install AWS CDK | ||
run: npm install -g aws-cdk | ||
|
||
- name: Configure AWS credentials | ||
uses: aws-actions/configure-aws-credentials@v4 | ||
with: | ||
role-to-assume: arn:aws:iam::017820688988:role/Space2Stats-Deploy-Role | ||
aws-region: ${{ vars.CDK_DEFAULT_REGION }} | ||
|
||
- name: Install CDK dependencies | ||
working-directory: ./space2stats_api/cdk | ||
run: | | ||
pip install -r requirements-cdk.txt | ||
- name: Tear down CDK stack | ||
working-directory: ./space2stats_api/cdk | ||
env: | ||
STAGE: pr-${{ github.event.pull_request.number }} | ||
PGHOST: ${{ secrets.PGHOST }} | ||
PGPORT: ${{ secrets.PGPORT }} | ||
PGDATABASE: ${{ secrets.PGDATABASE }} | ||
PGUSER: ${{ secrets.PGUSER }} | ||
PGPASSWORD: ${{ secrets.PGPASSWORD }} | ||
PGTABLENAME: ${{ secrets.PGTABLENAME }} | ||
CDK_CERTIFICATE_ARN: ${{ vars.CDK_CERTIFICATE_ARN }} | ||
CDK_DEFAULT_ACCOUNT: ${{ vars.CDK_DEFAULT_ACCOUNT }} | ||
CDK_DEFAULT_REGION: ${{ vars.CDK_DEFAULT_REGION }} | ||
CDK_DOMAIN_NAME: ${{ vars.CDK_DOMAIN_NAME }} | ||
run: cdk destroy --require-approval never | ||
|
||
- name: Find Comment | ||
uses: peter-evans/find-comment@v3 | ||
id: find-comment | ||
if: ${{ github.event.pull_request.number }} | ||
with: | ||
issue-number: ${{ github.event.pull_request.number }} | ||
comment-author: "github-actions[bot]" | ||
body-includes: "PR Deployment Details:" | ||
|
||
- name: Create or update comment with removal confirmation | ||
uses: peter-evans/create-or-update-comment@v4 | ||
if: ${{ github.event.pull_request.number }} | ||
with: | ||
issue-number: ${{ github.event.pull_request.number }} | ||
comment-id: ${{ steps.find-comment.outputs.comment-id }} | ||
body: | | ||
Removed PR Preview Environment. | ||
edit-mode: append |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
name: Deploy | ||
|
||
on: | ||
workflow_call: | ||
inputs: | ||
environment: | ||
type: string | ||
required: true | ||
stage: | ||
type: string | ||
required: true | ||
pr-number: | ||
type: number | ||
required: false | ||
|
||
permissions: | ||
id-token: write | ||
contents: read | ||
pull-requests: write | ||
|
||
jobs: | ||
deploy: | ||
concurrency: ${{ inputs.stage }} | ||
environment: ${{ inputs.environment }} | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Check out repository code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Install AWS CDK | ||
run: npm install -g aws-cdk | ||
|
||
- name: Configure AWS credentials | ||
uses: aws-actions/configure-aws-credentials@v4 | ||
with: | ||
role-to-assume: arn:aws:iam::017820688988:role/Space2Stats-Deploy-Role | ||
aws-region: ${{ vars.CDK_DEFAULT_REGION }} | ||
|
||
- name: Install CDK dependencies | ||
working-directory: ./space2stats_api/cdk | ||
run: | | ||
pip install -r requirements-cdk.txt | ||
- name: Deploy CDK stack to staging | ||
working-directory: ./space2stats_api/cdk | ||
env: | ||
STAGE: ${{ inputs.stage }} | ||
PGHOST: ${{ secrets.PGHOST }} | ||
PGPORT: ${{ secrets.PGPORT }} | ||
PGDATABASE: ${{ secrets.PGDATABASE }} | ||
PGUSER: ${{ secrets.PGUSER }} | ||
PGPASSWORD: ${{ secrets.PGPASSWORD }} | ||
PGTABLENAME: ${{ secrets.PGTABLENAME }} | ||
CDK_CERTIFICATE_ARN: ${{ vars.CDK_CERTIFICATE_ARN }} | ||
CDK_DEFAULT_ACCOUNT: ${{ vars.CDK_DEFAULT_ACCOUNT }} | ||
CDK_DEFAULT_REGION: ${{ vars.CDK_DEFAULT_REGION }} | ||
CDK_DOMAIN_NAME: ${{ vars.CDK_DOMAIN_NAME }} | ||
run: cdk deploy --require-approval never --outputs-file outputs.json | ||
|
||
- name: Get API URL | ||
id: get-api-url | ||
working-directory: ./space2stats_api/cdk | ||
run: | | ||
echo "api-url=$(jq -r '."Space2Stats-${{ inputs.stage }}".ApiGatewayUrl' outputs.json)" >> $GITHUB_OUTPUT | ||
- name: Find Comment | ||
uses: peter-evans/find-comment@v3 | ||
id: find-comment | ||
if: ${{ inputs.pr-number }} | ||
with: | ||
issue-number: ${{ inputs.pr-number }} | ||
comment-author: "github-actions[bot]" | ||
body-includes: "PR Deployment Details:" | ||
|
||
- name: Create or update comment with URL | ||
uses: peter-evans/create-or-update-comment@v4 | ||
if: ${{ inputs.pr-number }} | ||
with: | ||
issue-number: ${{ inputs.pr-number }} | ||
comment-id: ${{ steps.find-comment.outputs.comment-id }} | ||
body: | | ||
PR Deployment Details: | ||
🚀 PR deployed to ${{ steps.get-api-url.outputs.api-url }} | ||
edit-mode: replace |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,21 @@ | ||
import os | ||
|
||
from aws_cdk import App, Environment | ||
from aws_stack import Space2StatsStack | ||
from settings import DeploymentSettings | ||
|
||
settings = DeploymentSettings(_env_file="aws_deployment.env") | ||
settings = DeploymentSettings( | ||
_env_file=f"aws_deployment_{os.environ.get('STAGE', 'dev')}.env" | ||
) | ||
|
||
env = Environment( | ||
account=settings.CDK_DEFAULT_ACCOUNT, region=settings.CDK_DEFAULT_REGION | ||
) | ||
|
||
app = App() | ||
|
||
Space2StatsStack(app, "Space2StatsStack", env=env) | ||
Space2StatsStack( | ||
app, f"Space2Stats-{settings.STAGE}", env=env, deployment_settings=settings | ||
) | ||
|
||
app.synth() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
aws-cdk-lib==2.130.0 | ||
aws-cdk.aws-lambda-python-alpha==2.130.0-alpha.0 | ||
constructs==10.3.0 | ||
|
||
pydantic_settings>=2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters