Skip to content

Commit 9bce691

Browse files
committed
remove docker files + update README
1 parent c538127 commit 9bce691

File tree

4 files changed

+19
-69
lines changed

4 files changed

+19
-69
lines changed

Dockerfile

-20
This file was deleted.

README.md

+19-29
Original file line numberDiff line numberDiff line change
@@ -33,47 +33,37 @@ Observability:
3333
## 2. mass-gh-sponsor
3434
```
3535
➜ utils git:(master) ./scripts/mass-gh-sponsor --help
36-
Usage: mass-gh-sponsor --db-path="db.sql" --gh-classic-access-token=GH-ACCESS-TOKEN --entities=ENTITIES,...
36+
Usage: mass-gh-sponsor --db-path="db.sql" <command>
3737
3838
Flags:
39-
-h, --help Show context-sensitive help.
40-
-v, --version Print version and exit.
41-
-C, --config=FILE Config file ($CONFIG_PATH).
42-
--db-path="db.sql" Path to db file ($DB_PATH).
43-
--gh-classic-access-token=GH-ACCESS-TOKEN
44-
GitHub classis access token with admin:org & user scopes ($GH_CLASSIC_ACCESS_TOKEN).
45-
--entities=ENTITIES,... The GitHub entities to process sponsorships for. First entity in the list is considered
46-
DEFAULT.
47-
--sponsor-amount=1 The amount to donate to each dependency
39+
-h, --help Show context-sensitive help.
40+
-v, --version Print version and exit.
41+
-C, --config=FILE Config file ($CONFIG_PATH).
42+
--db-path="db.sql" Path to db file ($DB_PATH).
4843
4944
Observability:
5045
--log-level=info Log level (trace,debug,info,warning,error,fatal,panic).
5146
--log-json Log in JSON format.
5247
53-
wkr-donate
54-
--wkr-donate-disabled Flag to disable worker
55-
--wkr-donate-work-interval=10s Sleep duration per run while processing
56-
57-
wkr-entities
58-
--wkr-entities-disabled Flag to disable worker
59-
--wkr-entities-work-interval=10s Sleep duration per run while processing
48+
Commands:
49+
import-csv Import list of donations from csv file.
50+
dl-repos Import the user's github repos.
51+
animate-repos Animate the sponsorable dependencies for each repo.
52+
donate Create the require GitHub sponsorships.
6053
61-
wkr-repos
62-
--wkr-repos-disabled Flag to disable worker
63-
--wkr-repos-work-interval=10s Sleep duration per run while processing
54+
Run "mass-gh-sponsor <command> --help" for more information on a command.
6455
```
6556

66-
### 2.1 Run locally
57+
### 2.1 Run locally (import from gh)
6758
`. bin/activate-hermit`
68-
`GH_CLASSIC_ACCESS_TOKEN=<TOKEN> ./scripts/mass-gh-sponsor --config example.config.json`
59+
`GH_CLASSIC_ACCESS_TOKEN=<TOKEN> ./scripts/mass-gh-sponsor --log-level=debug dl-repos --entities=syntaxfm`
60+
`GH_CLASSIC_ACCESS_TOKEN=<TOKEN> ./scripts/mass-gh-sponsor --log-level=debug animate-repos`
61+
`GH_CLASSIC_ACCESS_TOKEN=<TOKEN> ./scripts/mass-gh-sponsor --log-level=debug donate`
6962

70-
### 2.2 Docker & docker compose
71-
A sample docker-compose.yml is provided to run this project.
72-
```
73-
cp example.env .env # update the latest api keys & access tokens
74-
cp example.config.json config.json # insert the github slugs of the user accounts / orgs
75-
docker compose --env-file .env up -d mass-gh-sponsor
76-
```
63+
### 2.2 Run locally (import from csv)
64+
`. bin/activate-hermit`
65+
`GH_CLASSIC_ACCESS_TOKEN=<TOKEN> ./scripts/mass-gh-sponsor --log-level=debug import-csv --entity=syntaxfm --file-path=<PATH_TO_CSV_FILE>`
66+
`GH_CLASSIC_ACCESS_TOKEN=<TOKEN> ./scripts/mass-gh-sponsor --log-level=debug donate`
7767

7868
## 3. TD-API-KEY
7969
To obtain a thanks.dev API key, log into thanks.dev and visit the settings screen. The API key configurations are located towards the bottom of the screen.

docker-compose.yml

-19
This file was deleted.

example.env

-1
This file was deleted.

0 commit comments

Comments
 (0)