Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
70 changes: 0 additions & 70 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,73 +88,3 @@ jobs:
with:
dir: 'infrastructure/aws'
skip_deploy: 'true'

deploy-development:
needs: [tests]
runs-on: ubuntu-latest
environment: dev
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
env:
UV_PYTHON: 3.12
TITILER_MULTIDIM_PYTHONWARNINGS: ignore
TITILER_MULTIDIM_DEBUG: true
STACK_ALARM_EMAIL: ${{ secrets.ALARM_EMAIL }}
STACK_CDK_DEFAULT_ACCOUNT: ${{ vars.STACK_CDK_DEFAULT_ACCOUNT }}
STACK_CDK_DEFAULT_REGION: ${{ vars.STACK_CDK_DEFAULT_REGION }}
STACK_READER_ROLE_ARN: ${{ vars.STACK_READER_ROLE_ARN }}
STACK_STAGE: ${{ vars.STACK_STAGE }}
STACK_VPC_ID: ${{ vars.STACK_VPC_ID }}

defaults:
run:
working-directory: infrastructure/aws

steps:
- uses: actions/checkout@v4

- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: ${{ vars.AWS_ROLE_ARN }}
role-session-name: github-actions-dev
aws-region: ${{ vars.STACK_CDK_DEFAULT_REGION }}

- uses: ./.github/actions/cdk-deploy
with:
dir: 'infrastructure/aws'
skip_deploy: 'false'

deploy-production:
needs: [tests]
runs-on: ubuntu-latest
environment: production
if: startsWith(github.ref, 'refs/tags/v')
env:
UV_PYTHON: 3.12
TITILER_MULTIDIM_PYTHONWARNINGS: ignore
TITILER_MULTIDIM_DEBUG: true
STACK_ALARM_EMAIL: ${{ secrets.ALARM_EMAIL }}
STACK_CDK_DEFAULT_ACCOUNT: ${{ vars.STACK_CDK_DEFAULT_ACCOUNT }}
STACK_CDK_DEFAULT_REGION: ${{ vars.STACK_CDK_DEFAULT_REGION }}
STACK_READER_ROLE_ARN: ${{ vars.STACK_READER_ROLE_ARN }}
STACK_STAGE: ${{ vars.STACK_STAGE }}
STACK_VPC_ID: ${{ vars.STACK_VPC_ID }}

defaults:
run:
working-directory: infrastructure/aws

steps:
- uses: actions/checkout@v4

- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: ${{ vars.AWS_ROLE_ARN }}
role-session-name: github-actions-dev
aws-region: ${{ vars.STACK_CDK_DEFAULT_REGION }}

- uses: ./.github/actions/cdk-deploy
with:
dir: 'infrastructure/aws'
skip_deploy: 'false'
28 changes: 10 additions & 18 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,15 @@
# Releasing

This repository deploys to 2 stacks (one production and one development) via github actions. These deployments are intended to be services in beta for demonstration in [NASA's VEDA project](https://www.earthdata.nasa.gov/esds/veda).

The production stack will be deployed when main is tagged (aka "released"). The production stack has the domain https://prod-titiler-xarray.delta-backend.com.

The development stack will be deployed upon pushes to the dev and main branches. The development stack will have the domain https://dev-titiler-xarray.delta-backend.com.
Deploying titiler-multidim to VEDA environments is configured and executed via the [veda-deploy](https://github.com/NASA-IMPACT/veda-deploy) repo.

## Release Workflow:

### Pre-release steps
1. PRs are made to `dev` branch. PRs should include tests and documentation. pytest should succeed before merging. If appropriate, changes should be added to the CHANGELOG.md file under "Next release".
2. Once merged, https://dev-titiler-xarray.delta-backend.com will be deployed and should be manually tested.

### Release steps

Before releasing, it is recommended to run benchmarks to compare performance between the development and production deployments. Run benchmarks between prod and dev via the [Run Benchmarks workflow in the tile-benchmarking repo](https://github.com/developmentseed/tile-benchmarking/actions/workflows/run-benchmarks.yml). Once the workflow completes, inspect the output of the "Upload results to S3" step for each environment to get the directory prefix for the past run. The output can be reviewed using the https://github.com/developmentseed/tile-benchmarking/blob/main/03-e2e/compare-prod-dev.ipynb notebook.


3. When it is time to release changes to production, add changes to CHANGELOG.md under a new release version and commit to dev. The `dev` branch will be merged to the `main` branch (no PR necessary).
4. The development deployment is updated to the latest commit on main. This should be manually tested again.
5. When ready, a release will be created on main by creating a tag. This will trigger the production deployment.
6. The production deployment (https://prod-titiler-xarray.delta-backend.com) should be manually tested.
1. **Open pull requests:** PRs are made to the `main` branch. PRs should include tests and documentation. pytest should succeed before merging. If appropriate, changes should be added to the CHANGELOG.md file under the [**Unreleased**](https://github.com/developmentseed/titiler-multidim/blob/remove-automated-deployment-actions/CHANGELOG.md#unreleased) header.
2. **Deploy to SMCE Staging:** Once merged, deploy titiler-multidim to the smce-staging environment of veda-deploy.
1. Verify `TITILER_MULTIDIM_GIT_REF` in the [smce-staging environment of veda-deploy](https://github.com/NASA-IMPACT/veda-deploy/settings/environments/4556936903/edit) is set to `main`.
2. Follow the steps in [veda-deploy's How to deploy section](https://github.com/NASA-IMPACT/veda-deploy?tab=readme-ov-file#how-to-deploy). Select `smce-staging` for `Environment to deploy to` and ensure only `DEPLOY_TITILER_MULTIDIM` is checked.
3. **Deploy to MCP Prod:** When it is time to release changes to [veda-deploy's MCP environment](https://github.com/NASA-IMPACT/veda-deploy/settings/environments/2525365130/edit):
1. Add a new release version heading (e.g. `v0.2.1`) to the top of CHANGELOG.md under the **Unreleased** header, so previously unreleased changes are documented as a part of the new release and new changes can still be added under **Unreleased**.
2. Tag `main` with the new release version (e.g. `v0.2.1`).
3. Update the `TITILER_MULTIDIM_GIT_REF` in [veda-deploy's MCP environment](https://github.com/NASA-IMPACT/veda-deploy/settings/environments/2525365130/edit) to the release tag (e.g. `v0.2.1`).
4. Follow the steps in [veda-deploy's How to deploy section](https://github.com/NASA-IMPACT/veda-deploy?tab=readme-ov-file#how-to-deploy). Select `mcp-prod` for `Environment to deploy to` and ensure only `DEPLOY_TITILER_MULTIDIM` is checked.