Skip to content

Commit de73036

Browse files
author
David Cavazos
committed
add tool summary
1 parent b7e6c59 commit de73036

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

.github/cloud-samples-tools/README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This is a collection of tools used for Cloud Samples maintenance and infrastructure.
44

5+
This tool has one function:
6+
7+
- `affected` finds the affected packages given a list of diffs.
8+
59
## Config files
610

711
For this tools, we refer to a **package** as an isolated directory, which contains a "package file".
@@ -74,16 +78,3 @@ We pass the config file and the diffs file as positional arguments.
7478
```sh
7579
/tmp/tools affected .github/config/nodejs.jsonc /tmp/diffs.txt
7680
```
77-
78-
## Running on all packages
79-
80-
> This must run at the repository root directory.
81-
82-
We pass the config file and a bash script to run as positional arguments.
83-
The script must receive a single positional argument in `$1` as the package name.
84-
For example, the script should be called like `bash path/to/my-script.sh path/to/package`.
85-
86-
```sh
87-
# To run all the Node.js tests.
88-
/tmp/tools run-all ./github/config/nodejs.jsonc ./github/scripts/nodejs-test.sh
89-
```

0 commit comments

Comments
 (0)