-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good for the 'how do I do this?' view, but there is likely more detail needed for the 'what does this system look like & why are certain things true' view. For example what is mise used for & what tests are being run?
Merging this now is ok, but I think we'll need a bit more detail somewhere to match what we have here: https://github.com/cipherstash/cipherstash-suite/blob/main/docs/diagrams/console-api-releases.drawio.svg
README.md
Outdated
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) |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
This is good feedback, thanks @cisopaul. I have added docs explaining the project layout: ![]() I have added docs explaining what the tests are testing: ![]() I have added a diagram explaining how the testing works: ![]() |
- Automatically whenever there are changes in the `sql/`, `tests/`, or `tasks/` directories | ||
- By manually running [the workflow](https://github.com/cipherstash/encrypt-query-language/actions/workflows/test-eql.yml) | ||
|
||
This is how the `test-eql.yml` workflow functions: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section is really good. We should try to use this in the other places.
And where to find build artifacts
d064898
to
2e90937
Compare
mise run build
that tells the user where to find build artifacts