You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -393,6 +393,34 @@ To cut a [release](https://github.com/cipherstash/encrypt-query-language/release
393
393
394
394
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/).
395
395
396
+
## Developing
397
+
398
+
### How this project is organised
399
+
400
+
Development is managed through [mise](https://mise.jdx.dev/), both locally and [in CI](https://github.com/cipherstash/encrypt-query-language/actions).
401
+
402
+
mise has tasks for:
403
+
404
+
- Building EQL install and uninstall scripts (`build`)
405
+
- Starting and stopping PostgreSQL containers (`postgres:up`, `postgres:down`)
406
+
- Running unit and integration tests (`test`, `reset`)
407
+
408
+
These are the important files in the repo:
409
+
410
+
```
411
+
.
412
+
├── mise.toml <-- the main config file for mise
413
+
├── tasks/ <-- mise tasks
414
+
├── sql/ <-- The individual SQL components that make up EQL
415
+
├── docs/ <-- Tutorial, reference, and concept documentation
416
+
├── tests/ <-- Unit and integration tests
417
+
│ ├── docker-compose.yml <-- Docker configuration for running PostgreSQL instances
418
+
│ └── *.sql <-- Individual unit and integration tests
419
+
├── release/ <-- Build artifacts produced by the `build` task
420
+
├── examples/ <-- Example uses of EQL in different languages
421
+
└── playground/ <-- Playground enviroment for experimenting with EQL and CipherStash Proxy
422
+
```
423
+
396
424
## Testing
397
425
398
426
There are tests for testing EQL against PostgreSQL versions 14–17.
0 commit comments