Skip to content

Commit a5002bc

Browse files
change the mis-leading README.md
The readme says it is Markdown but actually HTML Also each section is messy
1 parent b7c10d3 commit a5002bc

File tree

2 files changed

+26
-20
lines changed

2 files changed

+26
-20
lines changed

auto-run-nondex/README.md

+26-20
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
# `runNondex`
21

3-
This script runs individual modules in the specified project with the `Nondex` tool and shows results automatically in the `markdown` format.
2+
What repo we want to run Nondex on?
43

5-
Output file is located inside the project folder and called `report_md.md` The output would only contain tests that are detected by the nondex tool as flaky, and the result includes the seeds used for the test and the status of the test result.
4+
1. This repo has not appeared in the latest `pr-data.csv`
5+
2. This repo contains pom.xml file.
66

7-
All the log information would be stored inside the `.runNondex` folder inside the project.
87

9-
Inside the `.runNondex` folder:
10-
- `./LOGSSS` contains nondex logs for all submodules.
11-
- `LOGresult` contains a list of file paths that contain test errors.
12-
- `htmlOutput` contains a list of file paths for the HTML files generated by the nondex tool.
8+
9+
10+
# runNondexAll
11+
12+
This is simplified script for quick start
13+
Go to folder of .pom.xml files, and check all the result in result.log
14+
15+
16+
# Dependencies
1317

1418
It is recommended to use a virtual python environment for the required modules:
1519
```bash
1620
python3 -m venv <path_to_the_new_virtual_environment>
1721
source <path_to_the_new_virtual_environment>/bin/activate
1822
```
19-
2023
Make sure to first install packages in `requirements.txt`.
2124

2225
```bash
@@ -25,26 +28,22 @@ cd auto-run-nondex
2528
pip install -r requirements.txt
2629
```
2730

28-
# `runNondexUnderAuthor`
29-
30-
This script runs all the valid repos under a given author using the `runNondex` script above.
31-
32-
The valid repo is defined as:
31+
# runNondex in each module:
32+
```bash
33+
./runNondex.sh <project_folder_path> <optional-directory-name>
34+
```
3335

34-
1. This repo has not appeared in the latest `pr-data.csv`
35-
2. This repo contains pom.xml file.
36+
With the second parameter in `./runNondex.sh`, you can only run Nondex on modules in a certain directory instead of the entire project.
3637

3738

39+
# runNondexUnderAuthor
3840

3941

40-
### Usage:
4142
```bash
42-
./runNondex.sh <project_folder_path> <optional-directory-name>
4343
./runNondexUnderAuthor.sh <author_repository_url> <path_where_you_want_to_clone_those repos>
4444
```
4545

46-
With the second parameter in `./runNondex.sh`, you can only run Nondex on modules in a certain directory instead of the entire project.
47-
46+
How to find the Author?
4847

4948
> To find the author_repository_url, find the author that you want to run Nondex with, and get this author's repository overview url (e.g., https://github.com/orgs/spotify/repositories). Note that you don't need to provide the url with other parameters, as the script will automatically add the parameters needed.
5049
>
@@ -65,3 +64,10 @@ With the second parameter in `./runNondex.sh`, you can only run Nondex on module
6564
> `find . -maxdepth 1 -type d \( ! -name . \) -exec bash -c "cd '{}' && git rev-parse HEAD && git config --get remote.origin.url | rev | cut -c5- | rev && cat .runNondex/htmlOutput && cat report_md.md" \; &> progress_stats.md`
6665
6766

67+
# Folder structure
68+
69+
All the log information would be stored inside the `.runNondex` folder inside the project.
70+
71+
- `./modulelog` contains nondex logs for all submodules.
72+
- `result` contains a list of file paths that contain test errors.
73+
- `htmlOutput` contains a list of file paths for the HTML files generated by the nondex tool.

auto-run-nondex/runNondexAll.sh

Whitespace-only changes.

0 commit comments

Comments
 (0)