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

Jump to bottom

docs: move make build instruction from paragraph into list #3193

Merged
merged 3 commits into from
Mar 21, 2023
Merged

docs: move make build instruction from paragraph into list #3193

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d71789b
docs: move `make build` instruction from paragraph into list
jrpear Mar 21, 2023
956e4c2
Update docs/content/contributing/tests.md
polarathene Mar 21, 2023
7417025
Merge branch 'master' into clarify-testing-doc
polarathene Mar 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/content/contributing/tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,13 @@ To run the test suite, you will need to:

### Executing Test(s)

We use `make` to run commands. You will first need to build the container image via `make build`. You can then:
We use `make` to run commands.

1. Run all tests: `make clean tests`
2. Run a single test: `make clean generate-accounts test/<TEST NAME WITHOUT .bats SUFFIX>`
3. Run multiple unrelated tests: `make clean generate-accounts test/<TEST NAME WITHOUT .bats SUFFIX>,<TEST NAME WITHOUT .bats SUFFIX>` (just add a `,` and then immediately write the new test name)
4. Run a whole set or all serial tests: `make clean generate-accounts tests/parallel/setX` where `X` is the number of the set or `make clean generate-accounts tests/serial`
1. First, build the container image: `make build`. You can then:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
1. First, build the container image: `make build`. You can then:
1. Run `make build` to create or update the local `mailserver-testing:ci` Docker image (_using the projects `Dockerfile`_)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Run `make build` to create or update the local `mailserver-testing:ci` Docker image (_using the projects `Dockerfile`_)

doesn't say that the following commands depend on the first one. I think this might be better:

First, run `make build` to create or update the local `mailserver-testing:ci` Docker image (_using the projects `Dockerfile`_)

2. Run all tests: `make clean tests`
3. Run a single test: `make clean generate-accounts test/<TEST NAME WITHOUT .bats SUFFIX>`
4. Run multiple unrelated tests: `make clean generate-accounts test/<TEST NAME WITHOUT .bats SUFFIX>,<TEST NAME WITHOUT .bats SUFFIX>` (just add a `,` and then immediately write the new test name)
5. Run a whole set or all serial tests: `make clean generate-accounts tests/parallel/setX` where `X` is the number of the set or `make clean generate-accounts tests/serial`

??? tip "Setting the Degree of Parallelization for Tests"

Expand Down