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.

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

Conversation

auxesis
Copy link
Contributor

@auxesis auxesis commented Jan 14, 2025

  • Add steps describing how to do local development
  • Add steps for installing mise
  • Add section explaining project layout
  • Add explanation of what we're testing, and how changes trigger tests in CI
  • Add steps describing how to run tests for different Postgres versions
  • Add feedback at the end of mise run build that tells the user where to find build artifacts

Copy link

@cisopaul cisopaul left a 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)

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?

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.

@auxesis
Copy link
Contributor Author

auxesis commented Jan 14, 2025

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?

This is good feedback, thanks @cisopaul.

I have added docs explaining the project layout:

image

I have added docs explaining what the tests are testing:

image

I have added a diagram explaining how the testing works:

image

- 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:

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.

@auxesis auxesis force-pushed the docs/add-more-details-ci-docs branch from d064898 to 2e90937 Compare January 15, 2025 00:25
@auxesis auxesis merged commit 972ca20 into main Jan 15, 2025
4 checks passed
@auxesis auxesis deleted the docs/add-more-details-ci-docs branch January 15, 2025 00:42
@auxesis auxesis changed the title Explain how testing and CI works in more detail docs: Explain how testing and CI works in more detail Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants