Skip to content

docs: fix dotgithub add description (generates TypeScript code) #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danbot315 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix dotgithub add description (generates TypeScript code) #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c78184e
docs: clarify that dotgithub add generates TypeScript action wrappers
Mar 3, 2026
1e2274b
docs: clarify dotgithub add generates TypeScript wrappers in root README
Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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`

Expand Down
4 changes: 2 additions & 2 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -37,7 +37,7 @@ dotgithub --help
## Typical TypeScript workflow

1. `dotgithub init`
2. `dotgithub add <org/repo@version>`
2. `dotgithub add <org/repo@version>` (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
Expand Down