Skip to content

Commit 85db061

Browse files
committed
Include information on how to confirm application functionality
1 parent a5520ae commit 85db061

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,52 @@ additional records with a standardized template.
1919
- don't commit your .env or .env.development, but do commit .env.test after
2020
confirming your test values are not actual secrets that need protecting
2121

22+
## Confirming functionality after updating dependencies
23+
24+
This application has good code coverage, so most issues are detected by just running tests normally:
25+
26+
```shell
27+
bin/rails test
28+
```
29+
30+
The following additional manual testing should be performed in the PR build on Heroku.
31+
32+
- Use the PR builds GraphiQL playground to run a keyword search such as:
33+
34+
```graphql
35+
{
36+
search(searchterm: "thesis") {
37+
hits
38+
records {
39+
title
40+
source
41+
summary
42+
identifiers {
43+
kind
44+
value
45+
}
46+
}
47+
}
48+
}
49+
```
50+
51+
- Use the PR builds GraphiQL playground to retrieve a single record
52+
53+
```graphql
54+
{
55+
recordId(id: "alma:990000959610106761") {
56+
title
57+
timdexRecordId
58+
source
59+
}
60+
}
61+
```
62+
63+
The following additional manual check should be performed after the application is deployed to production.
64+
65+
- confirm the [main documentation site](https://mitlibraries.github.io/timdex/) is working by loading one or two pages
66+
- confirm the [technical documentation site](https://mitlibraries.github.io/timdex/reference/) is working by loading it
67+
2268
## Publishing User Facing Documentation
2369

2470
### Running jekyll documentation locally

0 commit comments

Comments
 (0)