Skip to content

Commit 0f40101

Browse files
authored
Add configuration settings
1 parent 6b493dc commit 0f40101

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,24 @@ If you start the ["Create branch/PR for schema change"](https://github.com/jonic
100100
If you like to install the workflows in your own repository, follow the [installation steps](#installation).
101101

102102
## Configuration
103+
104+
All scripts and IssueOps command in this repo have been designed to run successfully even if [zero configuration](#zero-setup-action-workflows-included-sparkles) was provided. If the defaut values do not fit your you, or you do not like to always authorize every action with the Web UI, here are the environment variables you can override in your CI/CD or set as [GitHub secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for your GitHub Action workflows to override default behavior.
105+
106+
### DB_NAME
107+
108+
***DB_NAME*** is name of your PlanetScale database. Unless you [attach](#ps-attach-attach-existing-planetscale-branch-or-deploy-request-to-your-pr) a specific branch or deploy request to your PR, it defaults to `example-db-<yourgithubaccount>`. If you rather like to change the source for the default DB name, it would be [this file](.pscale/cli-helper-scripts/set-db-and-org-and-branch-name.sh).
109+
110+
### ORG_NAME
111+
112+
***ORG_NAME*** is name of your PlanetScale organization. Unless you [attach](#ps-attach-attach-existing-planetscale-branch-or-deploy-request-to-your-pr) a specific branch or deploy request to your PR, it defaults to the first PlanetScale org you joined with your account. If you rather like to change the source for the default DB name, it would be [this file](.pscale/cli-helper-scripts/set-db-and-org-and-branch-name.sh).
113+
114+
### PLANETSCALE_SERVICE_TOKEN_NAME and PLANETSCALE_SERVICE_TOKEN
115+
116+
If you do not like to authorize actions by clicking on authorization links in the browser, you can [create PlanetScale service tokens](https://docs.planetscale.com/reference/service-tokens#create-service-tokens-using-the-planetscale-ui). Don't forget to set the [proper scopes](https://docs.planetscale.com/reference/service-tokens#add-database-access-permissions) for the database operations you like to automate.
117+
118+
**Note:** While service tokens can be used to work with existing databases, there is currently no scope to create new databases. This is why the scripts / workflows to create entirely new databses will always prompt you to authenticate via the Web UI.
119+
120+
### Initial table
121+
122+
When you create a bew database from scratch, a default table called `pixel_matrix` will be created. If you like to change this behavior, modify [this file](pscale-cli-helper-scripts/blob/main/.pscale/cli-helper-scripts/create-database.sh).
123+

0 commit comments

Comments
 (0)