Skip to content

Commit 1a367bb

Browse files
authored
Installer for pscale helper scripts
1 parent 377b0ae commit 1a367bb

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
📺 [Recording from live demo at PlanetScale Happy-Half-Hour](https://youtu.be/l3oe7srRUZw?t=610)
44

5-
Ever wanted to accomplish a complex database workflow with [pscale CLI](https://github.com/planetscale/cli) and needed a way to automate asynchronous operations like [database branch](https://docs.planetscale.com/concepts/branching) creation or [schema change requests](https://planetscale.com/blog/building-planetscale-with-planetscale) merges? Interested in using the PlanetScale database branching, approval and merging features directly out of your pull/merge requests?
5+
Ever wanted to accomplish a complex database workflow with [pscale CLI](https://github.com/planetscale/cli) and needed a way to automate operations like [database branch](https://docs.planetscale.com/concepts/branching) creation or [schema change requests](https://planetscale.com/blog/building-planetscale-with-planetscale) merges? Interested in using the PlanetScale database branching, approval and merging features directly out of your pull/merge requests?
66

77
![image](https://user-images.githubusercontent.com/1872314/144895567-85937eb8-25eb-4066-9863-8e834a108127.png)
88

9-
This is a collection of helper scripts around the PlanetScale CLI to synchronously
9+
This is a collection of helper scripts and building blocks around the PlanetScale CLI to
10+
* control PlanetScale branches and deploy requests directly from your Pull Requests (see [IssueOps section](#issue-ops-based-workflows))
1011
* [wait for branch creation to be completed](.pscale/cli-helper-scripts/wait-for-branch-readiness.sh)
1112
* [wait for deploy requests to be successfully merged](.pscale/cli-helper-scripts/wait-for-deploy-request-merged.sh) (and get an update on the current migration status)
1213
* [DB connection string creation/parsing and extending scope of service tokens](.pscale/cli-helper-scripts/create-database.sh)
@@ -17,6 +18,17 @@ This is a collection of helper scripts around the PlanetScale CLI to synchronous
1718

1819
## Issue-Ops based workflows
1920

21+
### Installation
22+
23+
To test out the IssueOps commands, either work on a [copy of this repo](https://github.com/jonico/pscale-cli-helper-scripts/generate) or run the following command in the root directory of your GitHub repo's workspace:
24+
25+
```bash
26+
curl https://raw.githubusercontent.com/jonico/pscale-cli-helper-scripts/main/install.sh | bash
27+
git add .pscale .github/workflows
28+
git commit -m "Add pscale helper scripts and IssueOps workflows"
29+
git push
30+
```
31+
2032
### /ps-create: Create PlanetScale Deploy Request from your PR
2133

2234
You can create a database branch and deploy request in an [already existing Pull Request](https://github.com/jonico/pscale-cli-helper-scripts/pull/2) using `/ps-create`:
@@ -54,7 +66,6 @@ Finally, you can delete the database branch associated with a Git branch using `
5466

5567
Stay tuned for updates and any feedbacks / PRs are welcome 😊
5668

57-
5869
## Zero-setup Action workflows included :sparkles:
5970

6071
In case you like to see those helper scripts in action without any further manual configuration, just

0 commit comments

Comments
 (0)