You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/scripts/uncover_assets_by_topic/README.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,14 @@ This script allows automatically uncovering Jit Github repo assets that have a s
6
6
7
7
To run the script, you'll need to prepare:
8
8
9
-
- A Jit client & secret
9
+
- A Jit client & secret[tutorial](https://docs.jit.io/docs/managing-users#generating-api-tokens)
10
10
- The name of your Github organization
11
11
- The name of the Github topic
12
12
- A valid Github token with read permissions to your organization
13
13
14
14
### Quickstart
15
15
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.
18
17
- Set the following environment variables locally:
19
18
```
20
19
GITHUB_TOKEN=<your github token>
@@ -23,16 +22,16 @@ To run the script, you'll need to prepare:
23
22
JIT_SECRET=<jit secret>
24
23
TOPIC_TO_UNCOVER=<topic name to uncover by>
25
24
```
26
-
- Run `python uncover_asets_by_topic.py`
25
+
- Run `python uncover_assets_by_topic.py`
27
26
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.
29
28
30
29
### Running in Github actions
31
30
32
31
If you want to run the script from a Github action, choose a repository in the same organization and do the following:
33
32
34
33
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:
36
35
37
36
- To generate & add them to Github sercrets, use the [tutorial](https://docs.jit.io/docs/managing-users#generating-api-tokens) in our docs.
38
37
- Make sure to name the Github secrets `JIT_CLIENT_ID` and `JIT_SECRET` in the same repo.
@@ -56,7 +55,7 @@ jobs:
56
55
- name: Set up Python
57
56
uses: actions/setup-python@v4
58
57
with:
59
-
python-version: "3.x" # Specify your Python version here
0 commit comments