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
Copy file name to clipboardExpand all lines: README.md
+3-50Lines changed: 3 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ For GitHub flow, feature branches are merged into the main branch and the main b
8
8
9
9
[release-action.yml](/.github/workflows/release-action.yml) builds the code and then for each environment migrate the databases and deploy the code. Using [environments with protection rules](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment#required-reviewers), it can deploy to the test environment automatically and push to the prod environment after approval.
10
10
11
-
## Use bytebase/bytebase-action (recommended)
11
+
## Use bytebase/bytebase-action
12
12
13
13
The README of bytebase/bytebase-action can be found at [README](https://github.com/bytebase/bytebase/blob/main/action/README.md).
14
14
@@ -26,7 +26,7 @@ Modify the environment variables to match your setup.
In the repository environments setting, create two environments: "test"and "prod". In the "prod" environment setting, configure "Deployment protection rules", check "Required reviewers" and add reviewers in order to rollout the "prod" environment after approval.
@@ -61,50 +61,3 @@ Set your service account password in the repository secrets setting with the nam
61
61
62
62
> [!IMPORTANT]
63
63
> The migration filename SHOULD comply to the naming scheme described in [bytebase-action](https://github.com/bytebase/bytebase/tree/main/action#global-flags) `--file-pattern` flag section.
64
-
65
-
## Use javascript actions
66
-
67
-
### How to configure sql-review.yml
68
-
69
-
Copy [sql-review.yml](/.github/workflows/sql-review.yml) to your repository.
70
-
71
-
Modify the environment variables to match your setup.
72
-
73
-
```yml
74
-
env:
75
-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # set GITHUB_TOKEN because the 'Check release' step needs it to comment the pull request with check results.
76
-
BYTEBASE_URL: https://demo.bytebase.com
77
-
BYTEBASE_SERVICE_ACCOUNT: ci@service.bytebase.com
78
-
BYTEBASE_PROJECT: "projects/project-sample"
79
-
BYTEBASE_TARGETS: "instances/test-sample-instance/databases/hr_test" # the database targets to check against.
80
-
FILE_PATTERN: "migrations/*.sql" # the glob pattern matching the migration files.
81
-
```
82
-
83
-
Set your service account password in the repository secrets setting with the name `BYTEBASE_SERVICE_ACCOUNT_SECRET`.
84
-
85
-
> [!IMPORTANT]
86
-
> The migration filename SHOULD comply to the naming scheme described in [bytebase-action](https://github.com/bytebase/bytebase/tree/main/action#global-flags) `--file-pattern` flag section.
87
-
88
-
### How to configure release.yml
89
-
90
-
Copy [release.yml](/.github/workflows/release.yml) to your repository.
91
-
92
-
Modify the environment variables to match your setup.
93
-
94
-
```yml
95
-
env:
96
-
BYTEBASE_URL: https://demo.bytebase.com
97
-
BYTEBASE_SERVICE_ACCOUNT: ci@service.bytebase.com
98
-
BYTEBASE_PROJECT: "projects/project-sample"
99
-
# The Bytebase rollout pipeline will deploy to 'test' and 'prod' environments.
100
-
# 'deploy_to_test' job rollouts the 'test' stage and 'deploy_to_prod' job rollouts the 'prod' stage.
FILE_PATTERN: "migrations/*.sql" # the glob pattern matching the migration files.
103
-
```
104
-
105
-
In the repository environments setting, create two environments: "test"and "prod". In the "prod" environment setting, configure "Deployment protection rules", check "Required reviewers" and add reviewers in order to rollout the "prod" environment after approval.
106
-
107
-
Set your service account password in the repository secrets setting with the name `BYTEBASE_SERVICE_ACCOUNT_SECRET`.
108
-
109
-
> [!IMPORTANT]
110
-
> The migration filename SHOULD comply to the naming scheme described in [bytebase-action](https://github.com/bytebase/bytebase/tree/main/action#global-flags) `--file-pattern` flag section.
0 commit comments