From c78184e5c2521a2cd08b8bd0b41089e99a946839 Mon Sep 17 00:00:00 2001 From: Daniel Clayton Date: Mon, 2 Mar 2026 19:52:48 -0700 Subject: [PATCH 1/2] docs: clarify that dotgithub add generates TypeScript action wrappers --- packages/cli/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/cli/README.md b/packages/cli/README.md index 915ee0e..dfa420c 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -20,7 +20,7 @@ npx @dotgithub/cli --help # Initialize DotGitHub config/files dotgithub init -# Add pinned GitHub Actions to your config +# Add action and generate TypeScript wrapper/types for it dotgithub add actions/checkout@v4 # Generate workflow files @@ -37,7 +37,7 @@ dotgithub --help ## Typical TypeScript workflow 1. `dotgithub init` -2. `dotgithub add ` +2. `dotgithub add ` (downloads metadata and generates TypeScript action wrappers) 3. author/update your workflow constructs in **TypeScript** 4. `dotgithub synth` to generate YAML 5. commit generated workflow files From 1e2274bdfba1f28f475a158555180039559b1ada Mon Sep 17 00:00:00 2001 From: Daniel Clayton Date: Tue, 3 Mar 2026 07:10:30 -0700 Subject: [PATCH 2/2] docs: clarify dotgithub add generates TypeScript wrappers in root README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9a597e8..b410f04 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,13 @@ dotgithub init dotgithub init --output ./my-workflows ``` -### Add GitHub Actions +### Add GitHub Actions (and generate TypeScript wrappers) ```bash -# Add a specific action +# Add a specific action and generate its TypeScript wrapper/types dotgithub add actions/checkout@v4 -# Add multiple actions +# Add multiple actions and generate wrappers for each dotgithub add actions/setup-node@v4 actions/setup-python@v5 ``` @@ -53,7 +53,7 @@ dotgithub synth ## Basic Usage 1. **Initialize** your project with `dotgithub init` -2. **Configure** actions in `dotgithub.json` +2. **Add actions** with `dotgithub add ...` (this generates TypeScript action wrappers and updates config) 3. **Write** your workflow logic in TypeScript 4. **Synthesize** workflows with `dotgithub synth`