Skip to content

docs: revamp docs #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 14, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,7 @@ release/

# jupyter notebook
.ipynb_checkpoints
__pycache__
__pycache__

# dbdev
eql--*.sql
22 changes: 22 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,28 @@ To cut a [release](https://github.com/cipherstash/encrypt-query-language/release

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/).

### dbdev

We publish a Trusted Language Extension for PostgreSQL for use on [dbdev](https://database.dev/).
You can find the extension on [dbdev's extension catalog](https://database.dev/cipherstash/eql).

#### Publishing to dbdev

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

Steps to publish

> [!NOTE]
> Make sure you have the [dbdev CLI](https://supabase.github.io/dbdev/cli/) installed and logged in using the `dbdev shared token` in 1Password.

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).
2. After the build is complete, you will have a file in the `dbdev` directory called `eql--0.0.0.sql`.
3. Update the file name from `eql--0.0.0.sql` replacing `0.0.0` with the version number of the release.
4. Also update the `eql.control` file with the new version number.
5. Run `dbdev publish` to publish the extension to dbdev.

Reach out to @calvinbrewer if you need help.

## Building

### Dependencies
Expand Down
Loading