@synergenius/flowweaver-pack-github-actions 0.1.1 → 0.1.2
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 +62 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# @synergenius/flowweaver-pack-github-actions
|
|
2
|
+
|
|
3
|
+
GitHub Actions CI/CD export target for [Flow Weaver](https://github.com/synergenius-fw/flow-weaver).
|
|
4
|
+
|
|
5
|
+
Generates native `.github/workflows/<name>.yml` files from Flow Weaver CI/CD workflows. No runtime dependency — outputs pure GitHub Actions YAML.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @synergenius/flowweaver-pack-github-actions
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
This package is a **marketplace pack** — once installed, Flow Weaver automatically discovers it via `createTargetRegistry()`.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
### CLI
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Export a CI/CD workflow as GitHub Actions YAML
|
|
21
|
+
npx flow-weaver export my-pipeline.ts --target github-actions
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### Programmatic
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { createTargetRegistry } from '@synergenius/flow-weaver/deployment';
|
|
28
|
+
|
|
29
|
+
const registry = await createTargetRegistry(process.cwd());
|
|
30
|
+
const gha = registry.get('github-actions');
|
|
31
|
+
|
|
32
|
+
const artifacts = await gha.generate({
|
|
33
|
+
sourceFile: 'my-pipeline.ts',
|
|
34
|
+
workflowName: 'myPipeline',
|
|
35
|
+
displayName: 'my-pipeline',
|
|
36
|
+
outputDir: './dist/github-actions',
|
|
37
|
+
});
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## What it generates
|
|
41
|
+
|
|
42
|
+
- `.github/workflows/<name>.yml` — Native GitHub Actions workflow
|
|
43
|
+
- `SECRETS_SETUP.md` — Documentation for required secrets
|
|
44
|
+
|
|
45
|
+
### Mapping
|
|
46
|
+
|
|
47
|
+
| Flow Weaver | GitHub Actions |
|
|
48
|
+
|-------------|---------------|
|
|
49
|
+
| `[job: "name"]` annotation | Job in `jobs:` |
|
|
50
|
+
| `@path` dependencies | `needs:` |
|
|
51
|
+
| `@secret NAME` | `${{ secrets.NAME }}` |
|
|
52
|
+
| `@cache` | `actions/cache@v4` |
|
|
53
|
+
| `@artifact` | `actions/upload-artifact@v4` / `actions/download-artifact@v4` |
|
|
54
|
+
| `@trigger push` | `on: push` |
|
|
55
|
+
|
|
56
|
+
## Requirements
|
|
57
|
+
|
|
58
|
+
- `@synergenius/flow-weaver` >= 0.14.0
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
See [LICENSE](./LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@synergenius/flowweaver-pack-github-actions",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "GitHub Actions CI/CD export target for Flow Weaver",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"flowweaver-marketplace-pack",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"typescript": "^5.0.0",
|
|
39
|
-
"@synergenius/flow-weaver": "^0.
|
|
39
|
+
"@synergenius/flow-weaver": "^0.17.1",
|
|
40
40
|
"@types/node": "^20.0.0"
|
|
41
41
|
},
|
|
42
42
|
"license": "SEE LICENSE IN LICENSE",
|