Skip to content

docs: Explain how testing and CI works in more detail #81

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.

Sign up for GitHub

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 11 commits into from
Jan 15, 2025
Merged

docs: Explain how testing and CI works in more detail #81

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
88b15b0
Explain how CI works in more detail
auxesis Jan 14, 2025
e47f58d
Add section explaining how the project is organised
auxesis Jan 14, 2025
b88238c
Explain what the tests are testing
auxesis Jan 14, 2025
7aca897
Diagram how the testing workflow runs
auxesis Jan 14, 2025
14471f0
Add testing and developing to the table of contents
auxesis Jan 14, 2025
55a051c
Improve wording and punctuation
auxesis Jan 14, 2025
c84106d
Provide feedback that the build has succeeded
auxesis Jan 15, 2025
70b2cfd
Add a quickstart for local development
auxesis Jan 15, 2025
0770fb0
Add instructions for how to install mise
auxesis Jan 15, 2025
ffed241
Explicitly document how to run the tests for other postgres versions
auxesis Jan 15, 2025
2e90937
Explain how to change ports so multiple containers can run at the sam…
auxesis Jan 15, 2025
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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,9 +395,14 @@ This will trigger the [Release EQL](https://github.com/cipherstash/encrypt-query

## Testing

There are tests for EQL for PostgreSQL versions 14–17.
There are tests for testing EQL against PostgreSQL versions 14–17.

They easiest way to run them is in [GitHub Actions](https://github.com/cipherstash/encrypt-query-language/actions/workflows/test-eql.yml).
The easiest way to run the tests is in GitHub Actions:

- [Automatically whenever there are changes](./.github/workflows/test-eql.yml) in the `sql/`, `tests/`, or `tasks/` directories
- By manually running [the workflow](https://github.com/cipherstash/encrypt-query-language/actions/workflows/test-eql.yml)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an arch diagram of what this looks like?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also ref this comment on line 394 for the release component

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be addressed in 7aca897.


You can also run the tests locally when doing local development.

### Running tests locally

Expand Down