Skip to content
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

Readme updates #3612

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Readme updates #3612

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a33bac9
Fix install-deps command
SkyLeite Dec 10, 2024
038ad2b
Add note about integration tests
SkyLeite Dec 10, 2024
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
6 changes: 4 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,19 @@ For usage information please refer to the [State Tool Documentation](http://docs

### Building & Testing

First run `state run install-deps` followed by `state run preprocess` if you are building for the first time.
First run `state run install-deps-dev` followed by `state run preprocess` if you are building for the first time.

* **Building:** `state run build`
* The built executable will be stored in the `build` directory
* If you modified assets or switched branches, you need to re-run `state run preprocess` first
* **Testing:**
* **Unit tests\*:** `state run test`
* **Integration tests:** `state run integration-tests`
* **Integration tests\*\*:** `state run build-svc && state run build-exec && state run integration-tests`

<sup>
* Our unit tests are in a state of slowly being converted to standalone
integration tests, meaning that while we refer to them as unit tests
they still contain a lot of tests that are better described as integration tests.

** Our integration tests rely on the secrets feature, which is (as of writing) not ready for production use. You must enable it with `state config set optin.unstable true` and authenticate with `state auth --prompt`.
</sup>
Loading