Skip to content

Commit a410c1c

Browse files
committed
Updated dev/release procedure in readme
1 parent 82acf45 commit a410c1c

1 file changed

Lines changed: 22 additions & 7 deletions

File tree

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,22 @@ If the structure of the report changes (new tests are added for example), you wi
66
If you don't have an existing CONFIG_FILE and you want to use it, go to https://firecracker-ui-prod.practitest.com/ and generate one.
77
To login, you can use your PractiTest credentials and follow the instructions in the link. Then you can continue here and set the config-path to your configuration file path.
88

9+
## Pre-requisites
10+
11+
- JDK 11
12+
- Babashka
13+
- Clojure CLI
14+
15+
## REPL
16+
17+
```shell
18+
bb dev
19+
```
20+
921
## Building uberjar
1022

1123
```shell
12-
clojure -A:depstar -m hf.depstar.uberjar practitest-firecracker-standalone.jar -C -m practitest-firecracker.core
24+
bb release
1325
```
1426

1527
## Usage
@@ -18,16 +30,17 @@ clojure -A:depstar -m hf.depstar.uberjar practitest-firecracker-standalone.jar -
1830

1931
At every point you can run:
2032

21-
``` shell
33+
```shell
2234
java -jar practitest-firecracker-standalone.jar help
2335
```
36+
2437
to get more information about the parameters and commands.
2538

2639
### version
2740

2841
To check your jar version you can you this command:
2942

30-
``` shell
43+
```shell
3144
java -jar practitest-firecracker-standalone.jar version
3245
```
3346

@@ -37,14 +50,15 @@ This will attempt to do the two actions above at once. It will search for a Test
3750

3851
Example:
3952

40-
``` shell
53+
```shell
4154
java -jar practitest-firecracker-standalone.jar \
4255
--reports-path=REPORTS_FOLDER_PATH \
4356
--author-id=PRACTITEST_USER_ID \
4457
--config-path=CONFIG_FILE \
4558
create-and-populate-testset
4659
```
47-
* author-id is not required in case of PAT (personal api token) is in use
60+
61+
- author-id is not required in case of PAT (personal api token) is in use
4862

4963
The call above will analyze the surefire reports and create and populate tests and the testset. If a test already exists, it will be reused.
5064

@@ -65,9 +79,9 @@ parameters:
6579
--additional-run-fields '{"custom-fields": {"---f-124": "test"}, "system-fields"{}}
6680
if they are relevant to the run (additional-fields not required).
6781

68-
6982
Example:
70-
``` shell
83+
84+
```shell
7185
java -jar practitest-firecracker-standalone.jar \
7286
--api-token=YOUR_API_TOKEN \
7387
--email=YOUR_EMAIL \
@@ -87,6 +101,7 @@ You can set various custom fields for tests when they are created (especially us
87101
Replace the field ids with the actual IDs, you can see all your custom fields by calling this API call: [get-all-custom-fields-in-your-project](https://www.practitest.com/api-v2/#get-all-custom-fields-in-your-project)
88102

89103
### Additional options
104+
90105
If you want to use firecracker custom uris you will need to add this --api-uri parameter like this
91106
for stage:
92107
--api-uri=https://stage.practitest.com/

0 commit comments

Comments
 (0)