Skip to content

Commit 68a924c

Browse files
committed
chore(docs): replace references to dev branch with main
1 parent 9a03049 commit 68a924c

File tree

19 files changed

+72
-72
lines changed

19 files changed

+72
-72
lines changed

.github/ISSUE_TEMPLATE/release.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ body:
5555
5656
Reference the diagram and discussion on [the release process docs](https://docs.calitp.org/benefits/deployment/release/).
5757
58-
* `Regular` release: propagates from `dev` to `test`, and then `test` to `prod`. Only possible if `dev` is ready to deploy.
59-
* `Hotfix` release: fix is merged into `prod`. After release, fix is propagated to `dev` and `test`.
58+
* `Regular` release: propagates from `main` to `test`, and then `test` to `prod`. Only possible if `main` is ready to deploy.
59+
* `Hotfix` release: fix is merged into `prod`. After release, fix is propagated to `main` and `test`.
6060
- type: dropdown
6161
id: type
6262
attributes:
@@ -78,12 +78,12 @@ body:
7878
label: Regular release checklist
7979
description: Complete these items in sequence as the `Regular` release progresses
8080
options:
81-
- label: Ensure the `dev` branch and secrets are up to date
81+
- label: Ensure the `main` branch and secrets are up to date
8282
- label: Create a branch called release/version from the source branch
8383
- label: Bump the application version
84-
- label: Open a PR for the release branch into `dev`, merge
84+
- label: Open a PR for the release branch into `main`, merge
8585
- label: Ensure `test` secrets are up to date
86-
- label: Open another PR from `dev` to `test`, merge
86+
- label: Open another PR from `main` to `test`, merge
8787
- label: QA the app in test
8888
- label: Ensure `prod` secrets are up to date
8989
- label: Open a PR for the `test` branch into `prod`, merge
@@ -109,7 +109,7 @@ body:
109109
- label: Create a release in GitHub for the tag, generating release notes
110110
- label: Edit release notes to link back to this Release process issue
111111
- label: Edit release notes with additional context, images, animations, etc. as-needed
112-
- label: Create a branch off `dev`
112+
- label: Create a branch off `main`
113113
- label: Open a PR from `prod` into that branch, merge
114-
- label: (optional) Adapt hotfix to current state of `dev` in that same branch
115-
- label: Merge the PR into `dev`
114+
- label: (optional) Adapt hotfix to current state of `main` in that same branch
115+
- label: Merge the PR into `main`

benefits/secrets.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def get_secret_by_name(secret_name, client=None):
6565
elif client is None:
6666
# construct the KeyVault URL from the runtime environment
6767
# see https://docs.calitp.org/benefits/deployment/infrastructure/#environments
68-
# and https://github.com/cal-itp/benefits/blob/dev/terraform/key_vault.tf
68+
# and https://github.com/cal-itp/benefits/blob/main/terraform/key_vault.tf
6969
vault_url = KEY_VAULT_URL.format(env=runtime_env[0])
7070
logger.debug(f"Configuring Azure KeyVault secrets client for: {vault_url}")
7171

docs/configuration/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ else:
7474
# do something when this agency is inactive
7575
```
7676

77-
[benefits-manage]: https://github.com/cal-itp/benefits/blob/dev/manage.py
78-
[benefits-settings]: https://github.com/cal-itp/benefits/blob/dev/benefits/settings.py
79-
[benefits-wsgi]: https://github.com/cal-itp/benefits/blob/dev/benefits/wsgi.py
77+
[benefits-manage]: https://github.com/cal-itp/benefits/blob/main/manage.py
78+
[benefits-settings]: https://github.com/cal-itp/benefits/blob/main/benefits/settings.py
79+
[benefits-wsgi]: https://github.com/cal-itp/benefits/blob/main/benefits/wsgi.py
8080
[django-model]: https://docs.djangoproject.com/en/5.0/topics/db/models/
8181
[django-settings]: https://docs.djangoproject.com/en/5.0/topics/settings/
8282
[django-using-settings]: https://docs.djangoproject.com/en/5.0/topics/settings/#using-settings-in-python-code

docs/configuration/data.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ bin/reset_db.sh
5252
See the [Django Environment Variables](environment-variables.md#django) section for details about how to configure the local
5353
database rebuild.
5454

55-
[core-models]: https://github.com/cal-itp/benefits/blob/dev/benefits/core/models.py
55+
[core-models]: https://github.com/cal-itp/benefits/blob/main/benefits/core/models.py
5656
[django-fixtures]: https://docs.djangoproject.com/en/5.0/topics/db/fixtures/
5757
[django-load-initial-data]: https://docs.djangoproject.com/en/5.0/howto/initial-data/
5858
[eligibility-server]: https://docs.calitp.org/eligibility-server
59-
[init]: https://github.com/cal-itp/benefits/blob/dev/bin/init.sh
60-
[reset-db]: https://github.com/cal-itp/benefits/blob/dev/bin/reset_db.sh
61-
[sample-fixtures]: https://github.com/cal-itp/benefits/tree/dev/benefits/core/migrations/local_fixtures.json
59+
[init]: https://github.com/cal-itp/benefits/blob/main/bin/init.sh
60+
[reset-db]: https://github.com/cal-itp/benefits/blob/main/bin/reset_db.sh
61+
[sample-fixtures]: https://github.com/cal-itp/benefits/tree/main/benefits/core/migrations/local_fixtures.json

docs/configuration/oauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ use in e.g. views.
3636
Consumers call `benefits.oauth.client.create_client(oauth, provider)` with the name of a client to obtain an Authlib client
3737
instance. If that client name has not been registered yet, `_register_provider(oauth_registry, provider)` uses data from the given `AuthProvider` instance to register the client into this instance and returns the client object.
3838

39-
[oauth-client]: https://github.com/cal-itp/benefits/blob/dev/benefits/oauth/client.py
39+
[oauth-client]: https://github.com/cal-itp/benefits/blob/main/benefits/oauth/client.py

docs/deployment/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Docker images for each of the deploy branches are available from GitHub Containe
3131
[oet]: https://techblog.cdt.ca.gov/2020/06/cdt-taking-the-lead-in-digital-transformation/
3232
[app-service-containers]: https://docs.microsoft.com/en-us/azure/app-service/configure-custom-container
3333
[app-service]: https://docs.microsoft.com/en-us/azure/app-service/overview
34-
[deploy-workflow]: https://github.com/cal-itp/benefits/blob/dev/.github/workflows/deploy.yml
35-
[dockerfile]: https://github.com/cal-itp/benefits/blob/dev/Dockerfile
34+
[deploy-workflow]: https://github.com/cal-itp/benefits/blob/main/.github/workflows/deploy.yml
35+
[dockerfile]: https://github.com/cal-itp/benefits/blob/main/Dockerfile
3636
[az-webapp]: https://azure.microsoft.com/en-us/services/app-service/containers/
3737
[ghcr]: https://github.com/features/packages

docs/deployment/infrastructure.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The infrastructure is configured as code via [Terraform](https://www.terraform.i
66

77
Since the Benefits app is deployed into a Microsoft Azure account provided by the California Department of Technology (CDT)'s Office of Enterprise Technology (OET) team, you'll need to request access from them to the `CDT Digital CA` directory so you can get into the [Azure portal](https://portal.azure.com), and to the `California Department of Technology` directory so you can access [Azure DevOps](https://calenterprise.visualstudio.com/CDT.OET.CAL-ITP).
88

9-
The Azure portal is where you can view the infrastructure resources for Benefits. Azure DevOps is where our [infrastructure pipeline](https://github.com/cal-itp/benefits/blob/dev/terraform/azure-pipelines.yml) is run to build and deploy those infrastructure resources.
9+
The Azure portal is where you can view the infrastructure resources for Benefits. Azure DevOps is where our [infrastructure pipeline](https://github.com/cal-itp/benefits/blob/main/terraform/azure-pipelines.yml) is run to build and deploy those infrastructure resources.
1010

1111
## Environments
1212

@@ -16,7 +16,7 @@ Each of our environments corresponds to a single Resource Group, [Terraform Work
1616

1717
| Environment | Subscription | Resource Group | Workspace | Branch |
1818
| ----------- | --------------------- | ----------------------------- | --------- | ------ |
19-
| Dev | `CDT/ODI Development` | `RG-CDT-PUB-VIP-CALITP-D-001` | `dev` | `dev` |
19+
| Dev | `CDT/ODI Development` | `RG-CDT-PUB-VIP-CALITP-D-001` | `dev` | `main` |
2020
| Test | `CDT/ODI Development` | `RG-CDT-PUB-VIP-CALITP-T-001` | `test` | `test` |
2121
| Prod | `CDT/ODI Production` | `RG-CDT-PUB-VIP-CALITP-P-001` | `default` | `prod` |
2222

@@ -146,15 +146,15 @@ Use the following shorthand for conveying the Resource Type as part of the Resou
146146
1. Install dependencies:
147147

148148
- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
149-
- [Terraform](https://www.terraform.io/downloads) - see exact version in [`deploy.yml`](https://github.com/cal-itp/benefits/blob/dev/terraform/pipeline/deploy.yml)
149+
- [Terraform](https://www.terraform.io/downloads) - see exact version in [`deploy.yml`](https://github.com/cal-itp/benefits/blob/main/terraform/pipeline/deploy.yml)
150150

151151
1. [Authenticate using the Azure CLI](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/azure_cli).
152152

153153
```sh
154154
az login
155155
```
156156

157-
1. Outside the [dev container](../../getting-started/), navigate to the [`terraform/`](https://github.com/cal-itp/benefits/tree/dev/terraform) directory.
157+
1. Outside the [dev container](../../getting-started/), navigate to the [`terraform/`](https://github.com/cal-itp/benefits/tree/main/terraform) directory.
158158
1. [Initialize Terraform.](https://www.terraform.io/cli/commands/init) You can also use this script later to switch between [environments](#environments).
159159

160160
```sh
@@ -189,7 +189,7 @@ When configuration changes to infrastructure resources are needed, they should b
189189

190190
[![Build Status](https://calenterprise.visualstudio.com/CDT.OET.CAL-ITP/_apis/build/status/cal-itp.benefits%20Infra?branchName=dev)](https://calenterprise.visualstudio.com/CDT.OET.CAL-ITP/_build/latest?definitionId=828&branchName=dev)
191191

192-
When code is pushed to any branch on GitHub, our infrastructure pipeline in Azure DevOps runs [`terraform plan`](https://www.terraform.io/cli/commands/plan). When the pull request is merged into `dev`, the pipeline runs [`terraform apply`](https://www.terraform.io/cli/commands/apply).
192+
When code is pushed to any branch on GitHub, our infrastructure pipeline in Azure DevOps runs [`terraform plan`](https://www.terraform.io/cli/commands/plan). When the pull request is merged into `main`, the pipeline runs [`terraform apply`](https://www.terraform.io/cli/commands/apply).
193193

194194
While other automation for this project is done through GitHub Actions, we use an Azure Pipeline for a couple of reasons:
195195

@@ -203,6 +203,6 @@ These steps were followed when setting up our Azure deployment for the first tim
203203
- CDT team creates the [resources that they own](#ownership)
204204
- `terraform apply`
205205
- Set up Slack notifications by [creating a Slack email](https://slack.com/help/articles/206819278-Send-emails-to-Slack) for the [#notify-benefits](https://cal-itp.slack.com/archives/C022HHSEE3F) channel, then [setting it as a Secret in the Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/secrets/quick-create-portal#add-a-secret-to-key-vault) named `slack-benefits-notify-email`
206-
- Set required [App Service configuration](../configuration/environment-variables.md) and [configuration](../configuration/data.md) by setting values in Key Vault (the mapping is defined in [app_service.tf](https://github.com/cal-itp/benefits/blob/dev/terraform/app_service.tf))
206+
- Set required [App Service configuration](../configuration/environment-variables.md) and [configuration](../configuration/data.md) by setting values in Key Vault (the mapping is defined in [app_service.tf](https://github.com/cal-itp/benefits/blob/main/terraform/app_service.tf))
207207

208208
This is not a complete step-by-step guide; more a list of things to remember. This may be useful as part of [incident response](https://docs.google.com/document/d/1qtev8qItPiTB4Tp9FQ87XsLtWZ4HlNXqoe9vF2VuGcY/edit#).

docs/deployment/release.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ version numbers look like: `YYYY.0M.R`
2727

2828
## 1. Prepare release in a branch
2929

30-
Typically changes for a release will move from `dev`, to `test`, to `prod`. This
31-
assumes `dev` is in a state that it can be deployed without disruption. (This is called a `Regular` release.)
30+
Typically changes for a release will move from `main`, to `test`, to `prod`. This
31+
assumes `main` is in a state that it can be deployed without disruption. (This is called a `Regular` release.)
3232

33-
If `dev` or `test` contain in-progress work that is not ready for production,
33+
If `main` or `test` contain in-progress work that is not ready for production,
3434
and a hotfix is needed in production, a separate process to test the changes
3535
before deploying to `prod` must be undertaken. (This is called a `Hotfix` release.)
3636

@@ -41,8 +41,8 @@ different circumstances:
4141

4242
```mermaid
4343
graph LR
44-
A(Release branch) --> B{Are dev and test ready to deploy?};
45-
B -->|Yes| C(dev);
44+
A(Release branch) --> B{Are main and test ready to deploy?};
45+
B -->|Yes| C(main);
4646
C --> D(test);
4747
D --> E(prod);
4848
B -->|No| E;
@@ -54,7 +54,7 @@ upcoming version number.
5454
## 2. Bump the application version number
5555

5656
The app code maintains a version number in
57-
[`benefits/__init__.py`](https://github.com/cal-itp/benefits/blob/dev/benefits/__init__.py),
57+
[`benefits/__init__.py`](https://github.com/cal-itp/benefits/blob/main/benefits/__init__.py),
5858
used by the instrumentation and logging systems.
5959

6060
This version number must be updated to match the new version in the same format:

docs/deployment/workflows.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ When a deployment workflow runs, the following steps are taken:
1515

1616
### 1. Checkout code
1717

18-
From the tip of the corresponding branch (e.g. `dev`)
18+
From the tip of the corresponding branch (e.g. `main`)
1919

2020
### 2. Authenticate to GHCR
2121

@@ -31,7 +31,7 @@ Push this image:tag into [GHCR][ghcr].
3131

3232
Push the new image:tag to the Azure App Service instance.
3333

34-
[deploy]: https://github.com/cal-itp/benefits/blob/dev/.github/workflows/deploy.yml
35-
[dockerfile]: https://github.com/cal-itp/benefits/blob/dev/Dockerfile
34+
[deploy]: https://github.com/cal-itp/benefits/blob/main/.github/workflows/deploy.yml
35+
[dockerfile]: https://github.com/cal-itp/benefits/blob/main/Dockerfile
3636
[ghcr]: https://github.com/features/packages
3737
[gh-actions-trigger]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows

docs/development/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,6 @@ To close out of the container and re-open the directory locally in Visual Studio
7777
1. Type `Remote-Containers` to filter the commands
7878
1. Select `Reopen Locally`
7979

80-
[config-file]: https://github.com/cal-itp/benefits/blob/dev/.devcontainer/devcontainer.json
80+
[config-file]: https://github.com/cal-itp/benefits/blob/main/.devcontainer/devcontainer.json
8181
[vscode]: https://code.visualstudio.com/
8282
[vscode-containers]: https://code.visualstudio.com/docs/remote/containers

0 commit comments

Comments
 (0)