Skip to content

Commit 597db56

Browse files
authored
Merge pull request #123 from cipherstash/docs-revamp
PR_BYPASS: out of date docs with new customer onboardings beginning
2 parents 1bb6ecd + 1a0d0d0 commit 597db56

File tree

16 files changed

+424
-1130
lines changed

16 files changed

+424
-1130
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,4 +203,7 @@ release/
203203

204204
# jupyter notebook
205205
.ipynb_checkpoints
206-
__pycache__
206+
__pycache__
207+
208+
# dbdev
209+
eql--*.sql

DEVELOPMENT.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,28 @@ To cut a [release](https://github.com/cipherstash/encrypt-query-language/release
274274

275275
This will trigger the [Release EQL](https://github.com/cipherstash/encrypt-query-language/actions/workflows/release-eql.yml) workflow, which will build and attach artifacts to [the release](https://github.com/cipherstash/encrypt-query-language/releases/).
276276

277+
### dbdev
278+
279+
We publish a Trusted Language Extension for PostgreSQL for use on [dbdev](https://database.dev/).
280+
You can find the extension on [dbdev's extension catalog](https://database.dev/cipherstash/eql).
281+
282+
#### Publishing to dbdev
283+
284+
**DISCLAIMER:** At the moment, we are manually publishing the extension to dbdev and the versions might not be in sync with the releases on GitHub until we automate this process.
285+
286+
Steps to publish
287+
288+
> [!NOTE]
289+
> Make sure you have the [dbdev CLI](https://supabase.github.io/dbdev/cli/) installed and logged in using the `dbdev shared token` in 1Password.
290+
291+
1. Run `mise run build` to build the extension which will create the following file in the `dbdev` directory. (Note: this release artifact is built from the Supabase release artifact).
292+
2. After the build is complete, you will have a file in the `dbdev` directory called `eql--0.0.0.sql`.
293+
3. Update the file name from `eql--0.0.0.sql` replacing `0.0.0` with the version number of the release.
294+
4. Also update the `eql.control` file with the new version number.
295+
5. Run `dbdev publish` to publish the extension to dbdev.
296+
297+
Reach out to @calvinbrewer if you need help.
298+
277299
## Building
278300

279301
### Dependencies

0 commit comments

Comments
 (0)