Skip to content

Commit 5fbba6e

Browse files
committed
improve documentation around developing and testing using local minio
1 parent a57eaa8 commit 5fbba6e

File tree

4 files changed

+15
-9
lines changed

4 files changed

+15
-9
lines changed

CONTRIBUTING.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,9 @@ in the nteract world? Here's a quick rundown!
3030

3131
5. Make the appropriate changes for the issue you are trying to address or the
3232
feature that you want to add.
33-
6. Confirm that unit tests and linting still pass successfully with:
34-
35-
yarn test
36-
37-
If tests fail, don't hesitate to ask for help.
38-
33+
6. You can run python unit tests using `pytest`. Running integration tests
34+
locally requires a more complicated setup. This setup is described in
35+
[running_ci_locally.md](./running_ci_locally.md)
3936
7. Add and commit the changed files using `git add` and `git commit`.
4037
8. Push the changes to the remote repository using:
4138

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,11 @@ c.BookstoreSettings.s3_bucket = "<bucket-name>"
8181
c.BookstoreSettings.s3_access_key_id = <AWS Access Key ID / IAM Access Key ID>
8282
c.BookstoreSettings.s3_secret_access_key = <AWS Secret Access Key / IAM Secret Access Key>
8383
```
84+
85+
## Developing
86+
87+
If you are developing on bookstore you will want to run the ci tests locally and to make releases.
88+
89+
Use [CONTRIBUTING.md](./CONTRIBUTING.md) to learn more about contributing.
90+
Use [running_ci_locally.md](./running_ci_locally.md) to learn more about running ci tests locally.
91+
Use [RELEASING.md](./RELEASING.md) to learn more about releasing bookstore.

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
},
99
"private": "true",
1010
"scripts": {
11-
"test": "node ci/integration.js"
11+
"test": "node ci/integration.js",
12+
"test:server": "./ci/local.sh"
1213
},
1314
"repository": {
1415
"type": "git",

running_ci_locally.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ You will also need a up-to-date version of `node`.
2323

2424
Create two shell sessions with working directories as the `bookstore` directory.
2525

26-
In one session run `ci/local.sh`, this will start up minio.
26+
In one session run `yarn test:server` (this will start up minio).
2727

28-
In the other session run `node ci/integration.js`, this will run the integration tests
28+
In the other session run `yarn test`, this will run the integration tests.

0 commit comments

Comments
 (0)