Skip to content

Commit df69853

Browse files
author
Moshiko Lev
authored
Merge pull request #26 from jitsecurity/Moshikol-patch-2
Update README.md
2 parents 1e3d7e5 + 3a66b78 commit df69853

1 file changed

Lines changed: 6 additions & 7 deletions

File tree

src/scripts/uncover_assets_by_topic/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,14 @@ This script allows automatically uncovering Jit Github repo assets that have a s
66

77
To run the script, you'll need to prepare:
88

9-
- A Jit client & secret
9+
- A Jit client & secret [tutorial](https://docs.jit.io/docs/managing-users#generating-api-tokens)
1010
- The name of your Github organization
1111
- The name of the Github topic
1212
- A valid Github token with read permissions to your organization
1313

1414
### Quickstart
1515

16-
- Copy the `uncover_assets_by_topic.py` and `requirements.txt` files locally.
17-
- Run `pip install -r requirements.txt`
16+
- Copy the `uncover_assets_by_topic.py` file locally.
1817
- Set the following environment variables locally:
1918
```
2019
GITHUB_TOKEN=<your github token>
@@ -23,16 +22,16 @@ To run the script, you'll need to prepare:
2322
JIT_SECRET=<jit secret>
2423
TOPIC_TO_UNCOVER=<topic name to uncover by>
2524
```
26-
- Run `python uncover_asets_by_topic.py`
25+
- Run `python uncover_assets_by_topic.py`
2726

28-
You should now see that the script runs successfully, and the relevat repos get uncovered from Jit. Note that organizations with a large number of repos can take a few minutes to complete.
27+
You should now see that the script runs successfully, and the relevant repos get uncovered from Jit. Note that organizations with a large number of repos can take a few minutes to complete.
2928

3029
### Running in Github actions
3130

3231
If you want to run the script from a Github action, choose a repository in the same organization and do the following:
3332

3433
1. Copy the `uncover_assets_by_topic.py` to the root of the repository
35-
2. Add the `JIT_CLIENT_ID` and `JIT_SECRET` as repository secret:
34+
2. Add the `JIT_CLIENT_ID` and `JIT_SECRET` as repository secrets:
3635

3736
- To generate & add them to Github sercrets, use the [tutorial](https://docs.jit.io/docs/managing-users#generating-api-tokens) in our docs.
3837
- Make sure to name the Github secrets `JIT_CLIENT_ID` and `JIT_SECRET` in the same repo.
@@ -56,7 +55,7 @@ jobs:
5655
- name: Set up Python
5756
uses: actions/setup-python@v4
5857
with:
59-
python-version: "3.x" # Specify your Python version here
58+
python-version: "3.11"
6059
6160
- name: Install dependencies
6261
run: |

0 commit comments

Comments
 (0)