From 78570f4dbc44873dc94844b83f2088c1970377fa Mon Sep 17 00:00:00 2001 From: Aimee Barciauskas Date: Thu, 13 Feb 2025 11:39:32 -0800 Subject: [PATCH 1/3] Update ci.yml --- .github/workflows/ci.yml | 70 ---------------------------------------- 1 file changed, 70 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 60b4483..b79918a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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' From eec78cfa9a3f730fcf506b89b210e0be1c0d1b58 Mon Sep 17 00:00:00 2001 From: Aimee Barciauskas Date: Thu, 13 Feb 2025 12:34:52 -0800 Subject: [PATCH 2/3] Update RELEASING.md --- RELEASING.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 069ee20..38535ad 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,23 +1,16 @@ # 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 `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 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 `dev`. + 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. Merge `dev` to main`. + 3. Tag `main` with the new release version (e.g. `v0.2.1`). + 4. 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`). + 5. 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. From 3681d71e65de6fcdd15ac4d89628ad48397085bd Mon Sep 17 00:00:00 2001 From: Aimee Barciauskas Date: Tue, 18 Feb 2025 12:53:51 -0500 Subject: [PATCH 3/3] Change `dev` to `main` --- RELEASING.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 38535ad..81d58e7 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -4,13 +4,12 @@ Deploying titiler-multidim to VEDA environments is configured and executed via t ## Release Workflow: -1. **Open pull requests:** PRs are made to the `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 the [**Unreleased**](https://github.com/developmentseed/titiler-multidim/blob/remove-automated-deployment-actions/CHANGELOG.md#unreleased) header. +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 `dev`. + 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. Merge `dev` to main`. - 3. Tag `main` with the new release version (e.g. `v0.2.1`). - 4. 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`). - 5. 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. + 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.