mirror of https://github.com/zcash/developers.git
Delete template_scripts and update README.
Signed-off-by: Daira Emma Hopwood <daira@jacaranda.org>
This commit is contained in:
parent
524d1171dd
commit
5d955a7857
21
README.md
21
README.md
|
@ -32,8 +32,11 @@ The DAG script depends upon GraphQL APIs for GitHub which can be generated using
|
|||
|
||||
## Generating DAGs
|
||||
|
||||
The `zcash-issue-dag.py` script supports several configuration options,
|
||||
also supplied as environment variables:
|
||||
The simplest way to generate one or more DAGs is to use `./gen-dag.sh` script. This takes
|
||||
a list of DAGs to render as arguments (default: `core wallet tfl halo2 zf`).
|
||||
|
||||
Alternatively, the `zcash-issue-dag.py` script supports several configuration options
|
||||
supplied as environment variables:
|
||||
|
||||
- `DAG_VIEW=[core|halo2|tfl|wallet|wallet-ios|wallet-android|zf]`: The DAG to render (default: `core`).
|
||||
- `SHOW_MILESTONES=[true|false]`: Whether or not to render GitHub milestones as boxes (default: `false`).
|
||||
|
@ -45,17 +48,3 @@ Example command:
|
|||
```
|
||||
DAG_VIEW=core SHOW_MILESTONES=false poetry run python ./zcash-issue-dag.py
|
||||
```
|
||||
|
||||
Here's an example command for easily running the DAG generator:
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
|
||||
DAG_VIEW=core \
|
||||
SHOW_MILESTONES=false \
|
||||
GITHUB_TOKEN=<INSERT> \
|
||||
ZENHUB_TOKEN=<INSERT> \
|
||||
poetry run python ./zcash-issue-dag.py
|
||||
```
|
||||
|
||||
You can find a series of template script files inside the folder `template_scripts`.
|
||||
|
|
|
@ -1,12 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
#GITHUB_TOKEN=<INSERT> \
|
||||
#ZENHUB_TOKEN=<INSERT> \
|
||||
poetry run python3 -m sgqlc.introspection \
|
||||
--exclude-deprecated \
|
||||
--exclude-description \
|
||||
-H "Authorization: bearer $GITHUB_TOKEN" \
|
||||
https://api.github.com/graphql \
|
||||
github_schema.json
|
||||
|
||||
poetry run sgqlc-codegen schema github_schema.json github_schema.py
|
|
@ -1,7 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
DAG_VIEW=wallet-android \
|
||||
SHOW_MILESTONES=true \
|
||||
#GITHUB_TOKEN=<INSERT> \
|
||||
#ZENHUB_TOKEN=<INSERT> \
|
||||
poetry run python ./zcash-issue-dag.py
|
|
@ -1,7 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
DAG_VIEW=wallet \
|
||||
SHOW_MILESTONES=true \
|
||||
#GITHUB_TOKEN=<INSERT> \
|
||||
#ZENHUB_TOKEN=<INSERT> \
|
||||
poetry run python ./zcash-issue-dag.py
|
|
@ -1,7 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
DAG_VIEW=wallet-ios \
|
||||
SHOW_MILESTONES=true \
|
||||
#GITHUB_TOKEN=<INSERT> \
|
||||
#ZENHUB_TOKEN=<INSERT> \
|
||||
poetry run python ./zcash-issue-dag.py
|
Loading…
Reference in New Issue