Skip to content

Add CI check for skill docs and update documentation #137

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

Merged
schpet merged 1 commit into from
Feb 12, 2026
Merged

Add CI check for skill docs and update documentation #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,18 @@ jobs:

- name: Run tests
run: deno task test

- name: Install linear-cli for skill generation
run: deno task install

- name: Check skill docs are up-to-date
run: |
deno task generate-skill-docs
if ! git diff --exit-code skills/; then
echo "Error: Generated skill documentation is out of date"
echo "Please run: deno task generate-skill-docs"
echo ""
echo "Changes needed:"
git diff skills/
exit 1
fi
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,34 @@ npx skills add schpet/linear-cli

view the skill at [skills.sh/schpet/linear-cli/linear-cli](https://skills.sh/schpet/linear-cli/linear-cli)

## development

### updating skill documentation

the skill documentation in `skills/linear-cli/` is automatically generated from the CLI help text. after making changes to commands or help text, regenerate the docs:

```bash
deno task generate-skill-docs
```

this will:

- discover all commands and subcommands from `linear --help`
- generate reference documentation for each command
- update the `SKILL.md` file from `SKILL.template.md`

**important:** the CI checks will fail if the generated docs are out of date, so make sure to run this before committing changes that affect command structure or help text.

### code formatting

ensure code is formatted consistently:

```bash
deno fmt
```

the project uses deno's built-in formatter with configuration in `deno.json`. formatting is checked in CI.

## why

linear's UI is incredibly good but it slows me down. i find the following pretty grating to experience frequently:
Expand Down
15 changes: 8 additions & 7 deletions skills/linear-cli/references/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@

```
Usage: linear api [query]
Version: 1.9.1
Version: 1.9.1

Description:

Make a raw GraphQL API request

Options:

-h, --help - Show this help.
-w, --workspace <slug> - Target workspace (uses credentials)
--variable <variable> - Variable in key=value format (coerces booleans, numbers, null; @file reads from path)
--variables-json <json> - JSON object of variables (merged with --variable, which takes precedence)
--paginate - Automatically fetch all pages using cursor pagination
--silent - Suppress response output (exit code still reflects errors)
-h, --help - Show this help.
-w, --workspace <slug> - Target workspace (uses credentials)
--variable <variable> - Variable in key=value format (coerces booleans, numbers, null; @file reads from
path)
--variables-json <json> - JSON object of variables (merged with --variable, which takes precedence)
--paginate - Auto-paginate a single connection field using cursor pagination
--silent - Suppress response output (exit code still reflects errors)
```
14 changes: 7 additions & 7 deletions skills/linear-cli/references/auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```
Usage: linear auth
Version: 1.8.1
Version: 1.9.1

Description:

Expand Down Expand Up @@ -35,7 +35,7 @@ Commands:

```
Usage: linear auth login
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -54,7 +54,7 @@ Options:

```
Usage: linear auth logout [workspace]
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -73,7 +73,7 @@ Options:

```
Usage: linear auth list
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -91,7 +91,7 @@ Options:

```
Usage: linear auth default [workspace]
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -109,7 +109,7 @@ Options:

```
Usage: linear auth token
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -127,7 +127,7 @@ Options:

```
Usage: linear auth whoami
Version: 1.8.1
Version: 1.9.1

Description:

Expand Down
2 changes: 1 addition & 1 deletion skills/linear-cli/references/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```
Usage: linear config
Version: 1.8.1
Version: 1.9.1

Description:

Expand Down
19 changes: 8 additions & 11 deletions skills/linear-cli/references/document.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```
Usage: linear document
Version: 1.8.1
Version: 1.9.1

Description:

Expand Down Expand Up @@ -34,7 +34,7 @@ Commands:

```
Usage: linear document list
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -56,7 +56,7 @@ Options:

```
Usage: linear document view <id>
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -77,7 +77,7 @@ Options:

```
Usage: linear document create
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -93,8 +93,7 @@ Options:
--project <project> - Attach to project (slug or ID)
--issue <issue> - Attach to issue (identifier like TC-123)
--icon <icon> - Document icon (emoji)
-i, --interactive - Interactive mode with prompts
--no-color - Disable colored output
-i, --interactive - Interactive mode with prompts
```

### update
Expand All @@ -103,7 +102,7 @@ Options:

```
Usage: linear document update <documentId>
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -117,8 +116,7 @@ Options:
-c, --content <content> - New markdown content (inline)
-f, --content-file <path> - Read new content from file
--icon <icon> - New icon (emoji)
-e, --edit - Open current content in $EDITOR for editing
--no-color - Disable colored output
-e, --edit - Open current content in $EDITOR for editing
```

### delete
Expand All @@ -127,7 +125,7 @@ Options:

```
Usage: linear document delete [documentId]
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -138,7 +136,6 @@ Options:
-h, --help - Show this help.
-w, --workspace <slug> - Target workspace (uses credentials)
-y, --yes - Skip confirmation prompt
--no-color - Disable colored output
--bulk <ids...> - Delete multiple documents by slug or ID
--bulk-file <file> - Read document slugs/IDs from a file (one per line)
--bulk-stdin - Read document slugs/IDs from stdin
Expand Down
9 changes: 4 additions & 5 deletions skills/linear-cli/references/initiative-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```
Usage: linear initiative-update
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -31,7 +31,7 @@ Commands:

```
Usage: linear initiative-update create <initiativeId>
Version: 1.8.1
Version: 1.9.1

Description:

Expand All @@ -44,8 +44,7 @@ Options:
--body <body> - Update content (markdown)
--body-file <path> - Read content from file
--health <health> - Health status (onTrack, atRisk, offTrack)
-i, --interactive - Interactive mode with prompts
--no-color - Disable colored output
-i, --interactive - Interactive mode with prompts
```

### list
Expand All @@ -54,7 +53,7 @@ Options:

```
Usage: linear initiative-update list <initiativeId>
Version: 1.8.1
Version: 1.9.1

Description:

Expand Down
Loading