Skip to content

Commit 6e5e165

Browse files
authored
Document CI variable
1 parent a05476f commit 6e5e165

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,10 @@ If you do not like to authorize actions by clicking on authorization links in th
117117

118118
**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.
119119

120+
### CI - Runnning in CI
121+
122+
GitHub Actions and many other CI/CD platforms set the **CI** variable to **true** when they run a script. The helper scripts in the [.pscale/cli-helper-scripts/ directory](.pscale/cli-helper-scripts/) will only prompt for interactive user input if the **CI** variable is not set. In CI mode, it will output additional [workflow commands](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions) to standard out to enable communication between GitHub Action workflow steps. If you are using a different CI/CD platform than GitHub Actions, you can ignore all lines starting with "::".
123+
120124
### Initial table
121125

122126
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/create-database.sh).
123-

0 commit comments

Comments
 (0)