gaji 0.4.3 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -6
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -3,12 +3,16 @@
|
|
|
3
3
|
<h1>gaji</h1>
|
|
4
4
|
<p>Type-safe GitHub Actions workflows in TypeScript</p>
|
|
5
5
|
<p><em>GitHub Actions Justified Improvements</em></p>
|
|
6
|
-
<p>🍆 Named after the Korean word "가지" (gaji, eggplant) - a versatile
|
|
6
|
+
<p>🍆 Named after the Korean word "가지" (gaji, eggplant) - a versatile vegetable</p>
|
|
7
|
+
<p>
|
|
8
|
+
<a href="https://crates.io/crates/gaji"><img src="https://img.shields.io/crates/v/gaji" alt="crates.io"></a>
|
|
9
|
+
<a href="https://www.npmjs.com/package/gaji"><img src="https://img.shields.io/npm/v/gaji" alt="npm"></a>
|
|
10
|
+
</p>
|
|
7
11
|
</div>
|
|
8
12
|
|
|
9
13
|
## Overview
|
|
10
14
|
|
|
11
|
-
`gaji` is a CLI tool that allows developers to write GitHub Actions workflows in TypeScript with full type safety, then compile them to YAML. It automatically fetches `action.yml` definitions and generates typed wrappers,
|
|
15
|
+
`gaji` is a CLI tool that allows developers to write GitHub Actions workflows in TypeScript with full type safety, then compile them to YAML. It automatically fetches `action.yml` definitions and generates typed wrappers, providing autocomplete and type checking for action inputs and outputs.
|
|
12
16
|
|
|
13
17
|
## Features
|
|
14
18
|
|
|
@@ -89,8 +93,6 @@ Run `gaji build` and it outputs `.github/workflows/ci.yml`.
|
|
|
89
93
|
|
|
90
94
|
### Recommended Development Workflow
|
|
91
95
|
|
|
92
|
-
For the best experience, follow this workflow:
|
|
93
|
-
|
|
94
96
|
1. **Start watch mode**:
|
|
95
97
|
```bash
|
|
96
98
|
gaji dev --watch
|
|
@@ -240,7 +242,7 @@ gaji dev [OPTIONS]
|
|
|
240
242
|
|
|
241
243
|
| Option | Description |
|
|
242
244
|
|---|---|
|
|
243
|
-
| `-
|
|
245
|
+
| `-i, --input <PATH>...` | Workflow directories or individual `.ts` files (default: `workflows`) |
|
|
244
246
|
| `--watch` | Keep watching for changes after the initial scan |
|
|
245
247
|
|
|
246
248
|
### `gaji build`
|
|
@@ -253,7 +255,7 @@ gaji build [OPTIONS]
|
|
|
253
255
|
|
|
254
256
|
| Option | Description |
|
|
255
257
|
|---|---|
|
|
256
|
-
| `-i, --input <
|
|
258
|
+
| `-i, --input <PATH>...` | Workflow directories or individual `.ts` files (default: `workflows`) |
|
|
257
259
|
| `-o, --output <DIR>` | Output directory for YAML files (default: `.github`) |
|
|
258
260
|
| `--dry-run` | Preview YAML output without writing files |
|
|
259
261
|
|
|
@@ -338,3 +340,15 @@ Check out the [examples/](examples/) directory for complete working examples:
|
|
|
338
340
|
## License
|
|
339
341
|
|
|
340
342
|
MIT License
|
|
343
|
+
|
|
344
|
+
## Special Thanks
|
|
345
|
+
|
|
346
|
+
### gaji Brand
|
|
347
|
+
|
|
348
|
+
- Name suggestions: [kiwiyou](https://github.com/kiwiyou), [RanolP](https://github.com/ranolp)
|
|
349
|
+
- Logo design: [sij411](https://github.com/sij411)
|
|
350
|
+
|
|
351
|
+
### Inspiration
|
|
352
|
+
|
|
353
|
+
- Client Devops Team@Toss: Without the experience on this team, I would never have thought deeply about YAML and GitHub Actions. The product below was also introduced to me through a teammate.
|
|
354
|
+
- [emmanuelnk/github-actions-workflow-ts](https://github.com/emmanuelnk/github-actions-workflow-ts): The idea of writing GitHub Actions in TypeScript came from here.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "gaji",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Type-safe GitHub Actions workflows in TypeScript",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -33,11 +33,11 @@
|
|
|
33
33
|
"provenance": true
|
|
34
34
|
},
|
|
35
35
|
"optionalDependencies": {
|
|
36
|
-
"@gaji/linux-x64": "0.
|
|
37
|
-
"@gaji/linux-arm64": "0.
|
|
38
|
-
"@gaji/darwin-x64": "0.
|
|
39
|
-
"@gaji/darwin-arm64": "0.
|
|
40
|
-
"@gaji/win32-x64": "0.
|
|
36
|
+
"@gaji/linux-x64": "0.5.0",
|
|
37
|
+
"@gaji/linux-arm64": "0.5.0",
|
|
38
|
+
"@gaji/darwin-x64": "0.5.0",
|
|
39
|
+
"@gaji/darwin-arm64": "0.5.0",
|
|
40
|
+
"@gaji/win32-x64": "0.5.0"
|
|
41
41
|
},
|
|
42
42
|
"keywords": [
|
|
43
43
|
"github-actions",
|