From 5d955a78573d734922f15d771659beec29cd2f29 Mon Sep 17 00:00:00 2001 From: Daira Emma Hopwood Date: Thu, 19 Oct 2023 23:22:18 +0100 Subject: [PATCH] Delete template_scripts and update README. Signed-off-by: Daira Emma Hopwood --- README.md | 21 +++++-------------- template_scripts/generate_schemas.sh | 12 ----------- .../generate_wallet_android_dag.sh | 7 ------- template_scripts/generate_wallet_dag.sh | 7 ------- template_scripts/generate_wallet_ios_dag.sh | 7 ------- 5 files changed, 5 insertions(+), 49 deletions(-) delete mode 100644 template_scripts/generate_schemas.sh delete mode 100644 template_scripts/generate_wallet_android_dag.sh delete mode 100644 template_scripts/generate_wallet_dag.sh delete mode 100644 template_scripts/generate_wallet_ios_dag.sh diff --git a/README.md b/README.md index dc0189a..d7ce1af 100644 --- a/README.md +++ b/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= \ -ZENHUB_TOKEN= \ -poetry run python ./zcash-issue-dag.py -``` - -You can find a series of template script files inside the folder `template_scripts`. diff --git a/template_scripts/generate_schemas.sh b/template_scripts/generate_schemas.sh deleted file mode 100644 index 6331749..0000000 --- a/template_scripts/generate_schemas.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env bash - -#GITHUB_TOKEN= \ -#ZENHUB_TOKEN= \ -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 diff --git a/template_scripts/generate_wallet_android_dag.sh b/template_scripts/generate_wallet_android_dag.sh deleted file mode 100644 index 5b3c935..0000000 --- a/template_scripts/generate_wallet_android_dag.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/env bash - -DAG_VIEW=wallet-android \ -SHOW_MILESTONES=true \ -#GITHUB_TOKEN= \ -#ZENHUB_TOKEN= \ -poetry run python ./zcash-issue-dag.py diff --git a/template_scripts/generate_wallet_dag.sh b/template_scripts/generate_wallet_dag.sh deleted file mode 100644 index 9f95b65..0000000 --- a/template_scripts/generate_wallet_dag.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/env bash - -DAG_VIEW=wallet \ -SHOW_MILESTONES=true \ -#GITHUB_TOKEN= \ -#ZENHUB_TOKEN= \ -poetry run python ./zcash-issue-dag.py diff --git a/template_scripts/generate_wallet_ios_dag.sh b/template_scripts/generate_wallet_ios_dag.sh deleted file mode 100644 index 868f0e1..0000000 --- a/template_scripts/generate_wallet_ios_dag.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/env bash - -DAG_VIEW=wallet-ios \ -SHOW_MILESTONES=true \ -#GITHUB_TOKEN= \ -#ZENHUB_TOKEN= \ -poetry run python ./zcash-issue-dag.py