-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update "master" branch language to "main"
- Loading branch information
Showing
4 changed files
with
23 additions
and
23 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 |
---|---|---|
|
@@ -2,7 +2,7 @@ name: Dispatch update | |
on: | ||
push: | ||
branches: | ||
- master | ||
- main | ||
workflow_dispatch: | ||
inputs: | ||
reason: | ||
|
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 |
---|---|---|
|
@@ -7,19 +7,19 @@ | |
- [Open a PR](#open-a-pr) | ||
- [Smoke test](#smoke-test) | ||
- [Using the sourcegraph/deploy-k8s-helper tool](#using-the-sourcegraphdeploy-k8s-helper-tool) | ||
- [Do smoke tests for `master` branch](#do-smoke-tests-for-master-branch) | ||
- [Check the upgrade path from the previous release to `master`](#check-the-upgrade-path-from-the-previous-release-to-master) | ||
- [Do smoke tests for `main` branch](#do-smoke-tests-for-main-branch) | ||
- [Check the upgrade path from the previous release to `main`](#check-the-upgrade-path-from-the-previous-release-to-main) | ||
- [Manual instructions](#manual-instructions) | ||
- [Provision a new cluster](#provision-a-new-cluster) | ||
- [Do smoke tests for `master` branch](#do-smoke-tests-for-master-branch-1) | ||
- [Check the upgrade path from the previous release to `master`](#check-the-upgrade-path-from-the-previous-release-to-master-1) | ||
- [Do smoke tests for `main` branch](#do-smoke-tests-for-main-branch-1) | ||
- [Check the upgrade path from the previous release to `main`](#check-the-upgrade-path-from-the-previous-release-to-main-1) | ||
- [Minikube](#minikube) | ||
|
||
## Docker images | ||
|
||
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. | ||
|
||
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. | ||
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. | ||
|
||
Release branches (`3.19`, etc) track specific versions instead, and updates are triggered manually for specific branches - see [cutting a release](#cutting-a-release). | ||
|
||
|
@@ -47,20 +47,20 @@ If you want to update Docker images manually, you can update the Docker image ve | |
|
||
### Open a PR | ||
|
||
Wait for buildkite to pass and for your changes to be approved, then merge and check out `master`. | ||
Wait for buildkite to pass and for your changes to be approved, then merge and check out `main`. | ||
|
||
### Smoke test | ||
|
||
Test what is currently checked in to master by [installing](docs/install.md) Sourcegraph on a fresh cluster. | ||
Test what is currently checked in to main by [installing](docs/install.md) Sourcegraph on a fresh cluster. | ||
|
||
#### Using the sourcegraph/deploy-k8s-helper tool | ||
|
||
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. | ||
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. | ||
|
||
##### Do smoke tests for `master` branch | ||
##### Do smoke tests for `main` branch | ||
|
||
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`) | ||
1. In your deploy-sourcegraph checkout, make sure that you're on the latest `master` | ||
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`) | ||
1. In your deploy-sourcegraph checkout, make sure that you're on the latest `main` | ||
1. Run `yarn up` in your https://github.com/sourcegraph/deploy-k8s-helper checkout | ||
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. | ||
1. Use the instructions in [configure.md](docs/configure.md) to: | ||
|
@@ -69,12 +69,12 @@ Clone [`sourcegraph/deploy-k8s-helper`](https://github.com/sourcegraph/deploy-k8 | |
1. Do a few test searches | ||
1. When you're done, run `yarn destroy` to tear the cluster down. This can take ~10 minutes. | ||
|
||
##### Check the upgrade path from the previous release to `master` | ||
##### Check the upgrade path from the previous release to `main` | ||
|
||
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.) | ||
1. Run `yarn up` in your https://github.com/sourcegraph/deploy-k8s-helper checkout | ||
1. Do [the same smoke tests that you did above](#Do-smoke-tests-for-master-branch) | ||
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. | ||
1. Do [the same smoke tests that you did above](#Do-smoke-tests-for-main-branch) | ||
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. | ||
1. When you're done, run `yarn destroy` to tear the cluster down. | ||
|
||
#### Manual instructions | ||
|
@@ -83,23 +83,23 @@ Clone [`sourcegraph/deploy-k8s-helper`](https://github.com/sourcegraph/deploy-k8 | |
|
||
Refer to [how to deploy a test cluster](https://about.sourcegraph.com/handbook/engineering/deployments#test-clusters). | ||
|
||
##### Do smoke tests for `master` branch | ||
##### Do smoke tests for `main` branch | ||
|
||
1. Deploy the latest `master` to your new cluster by running through the quickstart steps in [docs/install.md](docs/install.md) | ||
1. Deploy the latest `main` to your new cluster by running through the quickstart steps in [docs/install.md](docs/install.md) | ||
- 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)) | ||
- 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]` | ||
1. Use the instructions in [configure.md](docs/configure.md) to: | ||
1. Add a repository (e.g. [sourcegraph/sourcegraph](https://github.com/sourcegraph/sourcegraph)) | ||
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 | ||
1. Do a couple test searches | ||
|
||
##### Check the upgrade path from the previous release to `master` | ||
##### Check the upgrade path from the previous release to `main` | ||
|
||
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). | ||
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.) | ||
1. [Use the "Provision a new cluster" instructions above](#Provision-a-new-cluster) to create a new cluster. | ||
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. | ||
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. | ||
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. | ||
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. | ||
|
||
### Minikube | ||
|
||
|
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