Skip to content

Commit 67b9022

Browse files
authored
Merge pull request #7 from jitsecurity/sc-19672-create-a-tool-to-generate-teams-from-github-part3
modify readme to instruct the user to clone a specific release
2 parents 5acd090 + 95b15e7 commit 67b9022

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,14 @@ jit-customer-scripts/
4343
* To generate a Jit API Key Go to Settings -> Users & Permissions -> API Tokens in your
4444
Jit [dashboard](https://platform.jit.io).
4545

46+
> We recommend generating a fine-grained PAT with read-only access to the organization for the use of this script.
47+
4648
## Installation
4749

4850
1. Clone the repository:
4951

5052
```shell
51-
git clone git@github.com:jitsecurity/jit-customer-scripts.git
53+
git clone --branch 1.0 git@github.com:jitsecurity/jit-customer-scripts.git
5254
```
5355

5456
2. Change into the project directory:
@@ -100,6 +102,8 @@ python src/scripts/create_teams.py teams.json
100102
This command will fetch the repository names and topics from the GitHub API and generate the JSON file. And then it will
101103
create the teams and update the assets.
102104

105+
> We recommend using something like Github Actions and Github secrets to run this script on a schedule to make sure you are always synced.
106+
103107
### Using External JSON File
104108

105109
You can also provide a JSON file containing team details using a command line argument directly. The JSON file should

0 commit comments

Comments
 (0)