You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 9, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.dev.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -7,19 +7,19 @@
7
7
-[Open a PR](#open-a-pr)
8
8
-[Smoke test](#smoke-test)
9
9
-[Using the sourcegraph/deploy-k8s-helper tool](#using-the-sourcegraphdeploy-k8s-helper-tool)
10
-
-[Do smoke tests for `master` branch](#do-smoke-tests-for-master-branch)
11
-
-[Check the upgrade path from the previous release to `master`](#check-the-upgrade-path-from-the-previous-release-to-master)
10
+
-[Do smoke tests for `main` branch](#do-smoke-tests-for-main-branch)
11
+
-[Check the upgrade path from the previous release to `main`](#check-the-upgrade-path-from-the-previous-release-to-main)
12
12
-[Manual instructions](#manual-instructions)
13
13
-[Provision a new cluster](#provision-a-new-cluster)
14
-
-[Do smoke tests for `master` branch](#do-smoke-tests-for-master-branch-1)
15
-
-[Check the upgrade path from the previous release to `master`](#check-the-upgrade-path-from-the-previous-release-to-master-1)
14
+
-[Do smoke tests for `main` branch](#do-smoke-tests-for-main-branch-1)
15
+
-[Check the upgrade path from the previous release to `main`](#check-the-upgrade-path-from-the-previous-release-to-main-1)
16
16
-[Minikube](#minikube)
17
17
18
18
## Docker images
19
19
20
20
Refer to [deployment basics](https://about.sourcegraph.com/handbook/engineering/deployments#deployment-basics) to learn about Sourcegraph Docker images and [Renovate](https://renovatebot.com/docs/docker/), which performs most image updates.
21
21
22
-
The `master` branch of this repository is configured to track the latest builds from `sourcegraph/sourgraph@main`, tagged as `insiders`. Renovate automatically performs updates for these images.
22
+
The `main` branch of this repository is configured to track the latest builds from `sourcegraph/sourgraph@main`, tagged as `insiders`. Renovate automatically performs updates for these images.
23
23
24
24
Release branches (`3.19`, etc) track specific versions instead, and updates are triggered manually for specific branches - see [cutting a release](#cutting-a-release).
25
25
@@ -47,20 +47,20 @@ If you want to update Docker images manually, you can update the Docker image ve
47
47
48
48
### Open a PR
49
49
50
-
Wait for buildkite to pass and for your changes to be approved, then merge and check out `master`.
50
+
Wait for buildkite to pass and for your changes to be approved, then merge and check out `main`.
51
51
52
52
### Smoke test
53
53
54
-
Test what is currently checked in to master by [installing](docs/install.md) Sourcegraph on a fresh cluster.
54
+
Test what is currently checked in to main by [installing](docs/install.md) Sourcegraph on a fresh cluster.
55
55
56
56
#### Using the sourcegraph/deploy-k8s-helper tool
57
57
58
-
Clone [`sourcegraph/deploy-k8s-helper`](https://github.com/sourcegraph/deploy-k8s-helper) to your machine and follow the [README](https://github.com/sourcegraph/deploy-k8s-helper/blob/master/README.md) to set up all the prerequisistes.
58
+
Clone [`sourcegraph/deploy-k8s-helper`](https://github.com/sourcegraph/deploy-k8s-helper) to your machine and follow the [README](https://github.com/sourcegraph/deploy-k8s-helper/blob/main/README.md) to set up all the prerequisistes.
59
59
60
-
##### Do smoke tests for `master` branch
60
+
##### Do smoke tests for `main` branch
61
61
62
-
1. Ensure that the `deploySourcegraphRoot` value in your stack configuration (see https://github.com/sourcegraph/deploy-k8s-helper/blob/master/README.md) is pointing to your deploy-sourcegraph checkout (ex: `pulumi config set deploySourcegraphRoot /Users/ggilmore/dev/go/src/github.com/sourcegraph/deploy-sourcegraph`)
63
-
1. In your deploy-sourcegraph checkout, make sure that you're on the latest `master`
62
+
1. Ensure that the `deploySourcegraphRoot` value in your stack configuration (see https://github.com/sourcegraph/deploy-k8s-helper/blob/main/README.md) is pointing to your deploy-sourcegraph checkout (ex: `pulumi config set deploySourcegraphRoot /Users/ggilmore/dev/go/src/github.com/sourcegraph/deploy-sourcegraph`)
63
+
1. In your deploy-sourcegraph checkout, make sure that you're on the latest `main`
64
64
1. Run `yarn up` in your https://github.com/sourcegraph/deploy-k8s-helper checkout
65
65
1. It'll take a few minutes for the cluster to be provisioned and for sourcegraph to be installed. Pulumi will show you the progresss that it's making, and will tell you when it's done.
66
66
1. Use the instructions in [configure.md](docs/configure.md) to:
1. When you're done, run `yarn destroy` to tear the cluster down. This can take ~10 minutes.
71
71
72
-
##### Check the upgrade path from the previous release to `master`
72
+
##### Check the upgrade path from the previous release to `main`
73
73
74
74
1. In your deploy-sourcegraph checkout, checkout the commit that contains the configuration for the previous release (e.g. the commit that has `2.11.x` images if you're currently trying to release `2.12.x`, etc.)
75
75
1. Run `yarn up` in your https://github.com/sourcegraph/deploy-k8s-helper checkout
76
-
1. Do [the same smoke tests that you did above](#Do-smoke-tests-for-master-branch)
77
-
1. In your deploy-sourcegraph checkout, checkout the latest `master` commit again and run `yarn up` to deploy the new images. Check to see that [the same smoke tests](#Do-smoke-tests-for-master-branch) pass after the upgrade process.
76
+
1. Do [the same smoke tests that you did above](#Do-smoke-tests-for-main-branch)
77
+
1. In your deploy-sourcegraph checkout, checkout the latest `main` commit again and run `yarn up` to deploy the new images. Check to see that [the same smoke tests](#Do-smoke-tests-for-main-branch) pass after the upgrade process.
78
78
1. When you're done, run `yarn destroy` to tear the cluster down.
Refer to [how to deploy a test cluster](https://about.sourcegraph.com/handbook/engineering/deployments#test-clusters).
85
85
86
-
##### Do smoke tests for `master` branch
86
+
##### Do smoke tests for `main` branch
87
87
88
-
1. Deploy the latest `master` to your new cluster by running through the quickstart steps in [docs/install.md](docs/install.md)
88
+
1. Deploy the latest `main` to your new cluster by running through the quickstart steps in [docs/install.md](docs/install.md)
89
89
- You'll need to create a GCP Storage Class named `sourcegraph` with the same `zone` that you created your cluster in (see ["Configure a storage class"](docs/configure.md#Configure-a-storage-class))
90
90
- In order to give yourself permissions to create roles on the cluster, run: `kubectl create clusterrolebinding cluster-admin-binding --clusterrole cluster-admin --user [email protected]`
91
91
1. Use the instructions in [configure.md](docs/configure.md) to:
92
92
1. Add a repository (e.g. [sourcegraph/sourcegraph](https://github.com/sourcegraph/sourcegraph))
93
93
1. Enable a language extension (e.g. [Go](https://sourcegraph.com/extensions/sourcegraph/lang-go)), and test that code intelligence is working on the above repository
94
94
1. Do a couple test searches
95
95
96
-
##### Check the upgrade path from the previous release to `master`
96
+
##### Check the upgrade path from the previous release to `main`
97
97
98
98
1. Tear down the cluster that you created above by deleting it through from the [Sourcegraph CI GCP Project](https://console.cloud.google.com/kubernetes/list?project=sourcegraph-ci&organizationId=1006954638239).
99
99
1. Checkout the commit that contains the configuration for the previous release (e.g. the commit has `2.11.x` images if you're currently trying to release `2.12.x`, etc.)
100
100
1.[Use the "Provision a new cluster" instructions above](#Provision-a-new-cluster) to create a new cluster.
101
-
1. Deploy the older commit to the new cluster, and do [the same smoke tests](#Do-smoke-tests-for-master-branch) with the older version.
102
-
1. Checkout the latest `master`, deploy the newer images to the same cluster (without tearing it down in between) by running `./kubectl-apply-all.sh`, and check to see [that the smoke test](#Do-smoke-tests-for-master-branch) passes after the upgrade process.
101
+
1. Deploy the older commit to the new cluster, and do [the same smoke tests](#Do-smoke-tests-for-main-branch) with the older version.
102
+
1. Checkout the latest `main`, deploy the newer images to the same cluster (without tearing it down in between) by running `./kubectl-apply-all.sh`, and check to see [that the smoke test](#Do-smoke-tests-for-main-branch) passes after the upgrade process.
@@ -20,7 +20,7 @@ updating, and maintaining a Sourcegraph cluster.
20
20
21
21
> IMPORTANT: When upgrading Sourcegraph, please check [upgrading docs](https://docs.sourcegraph.com/admin/updates/kubernetes) to check if any manual migrations are necessary.
22
22
>
23
-
> The `master` branch tracks development. Use the branch of this repository corresponding to the
23
+
> The `main` branch tracks development. Use the branch of this repository corresponding to the
24
24
> version of Sourcegraph you wish to deploy, e.g. `git checkout 3.19`.
25
25
26
26
For product and [pricing](https://about.sourcegraph.com/pricing/) information, visit
0 commit comments