@invarn/cibuild 1.2.3 → 1.2.4
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 +52 -52
- package/dist/cli.cjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,58 +10,6 @@ npm install -g @invarn/cibuild
|
|
|
10
10
|
|
|
11
11
|
This installs two identical commands: `ci` and `cibuild`.
|
|
12
12
|
|
|
13
|
-
## GitHub Actions
|
|
14
|
-
|
|
15
|
-
Use cibuild directly in your GitHub Actions workflows:
|
|
16
|
-
|
|
17
|
-
```yaml
|
|
18
|
-
name: CI
|
|
19
|
-
on: [push, pull_request]
|
|
20
|
-
|
|
21
|
-
jobs:
|
|
22
|
-
build:
|
|
23
|
-
runs-on: macos-latest
|
|
24
|
-
environment: cibuild
|
|
25
|
-
steps:
|
|
26
|
-
- uses: actions/checkout@v4
|
|
27
|
-
- uses: invarnhq/cibuild@v1
|
|
28
|
-
with:
|
|
29
|
-
workflow: release
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
### Action Inputs
|
|
33
|
-
|
|
34
|
-
| Input | Required | Default | Description |
|
|
35
|
-
|---|---|---|---|
|
|
36
|
-
| `pipeline` | No | Auto-discover | Path to pipeline YAML file |
|
|
37
|
-
| `workflow` | No | First workflow | Workflow name within the pipeline |
|
|
38
|
-
| `version` | No | `latest` | cibuild version to install |
|
|
39
|
-
|
|
40
|
-
### Secrets in GitHub Actions
|
|
41
|
-
|
|
42
|
-
Upload your local secrets to a GitHub Environment, then reference them in your workflow:
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
ci secrets upload --env cibuild
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
```yaml
|
|
49
|
-
jobs:
|
|
50
|
-
build:
|
|
51
|
-
runs-on: macos-latest
|
|
52
|
-
environment: cibuild
|
|
53
|
-
env:
|
|
54
|
-
CIBUILD_S__SLACK_WEBHOOK: ${{ secrets.CIBUILD_S__SLACK_WEBHOOK }}
|
|
55
|
-
CIBUILD_SW__RELEASE__KEYSTORE_PASS: ${{ secrets.CIBUILD_SW__RELEASE__KEYSTORE_PASS }}
|
|
56
|
-
steps:
|
|
57
|
-
- uses: actions/checkout@v4
|
|
58
|
-
- uses: invarnhq/cibuild@v1
|
|
59
|
-
with:
|
|
60
|
-
workflow: release
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
The action automatically maps GitHub context to cibuild environment variables (`GIT_BRANCH`, `GIT_COMMIT`, `BUILD_NUMBER`, `BUILD_URL`).
|
|
64
|
-
|
|
65
13
|
## Getting Started
|
|
66
14
|
|
|
67
15
|
### Option 1. Auto-create (recommended)
|
|
@@ -145,6 +93,58 @@ ci secrets add KEYSTORE_BASE64 pipeline.yml --file release.keystore
|
|
|
145
93
|
ci secrets add SLACK_WEBHOOK pipeline.yml -w release
|
|
146
94
|
```
|
|
147
95
|
|
|
96
|
+
## GitHub Actions
|
|
97
|
+
|
|
98
|
+
Use cibuild directly in your GitHub Actions workflows:
|
|
99
|
+
|
|
100
|
+
```yaml
|
|
101
|
+
name: CI
|
|
102
|
+
on: [push, pull_request]
|
|
103
|
+
|
|
104
|
+
jobs:
|
|
105
|
+
build:
|
|
106
|
+
runs-on: macos-latest
|
|
107
|
+
environment: cibuild
|
|
108
|
+
steps:
|
|
109
|
+
- uses: actions/checkout@v4
|
|
110
|
+
- uses: invarnhq/cibuild@v1
|
|
111
|
+
with:
|
|
112
|
+
workflow: release
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Action Inputs
|
|
116
|
+
|
|
117
|
+
| Input | Required | Default | Description |
|
|
118
|
+
|---|---|---|---|
|
|
119
|
+
| `pipeline` | No | Auto-discover | Path to pipeline YAML file |
|
|
120
|
+
| `workflow` | No | First workflow | Workflow name within the pipeline |
|
|
121
|
+
| `version` | No | `latest` | cibuild version to install |
|
|
122
|
+
|
|
123
|
+
### Secrets in GitHub Actions
|
|
124
|
+
|
|
125
|
+
Upload your local secrets to a GitHub Environment, then reference them in your workflow:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
ci secrets upload --env cibuild
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
```yaml
|
|
132
|
+
jobs:
|
|
133
|
+
build:
|
|
134
|
+
runs-on: macos-latest
|
|
135
|
+
environment: cibuild
|
|
136
|
+
env:
|
|
137
|
+
CIBUILD_S__SLACK_WEBHOOK: ${{ secrets.CIBUILD_S__SLACK_WEBHOOK }}
|
|
138
|
+
CIBUILD_SW__RELEASE__KEYSTORE_PASS: ${{ secrets.CIBUILD_SW__RELEASE__KEYSTORE_PASS }}
|
|
139
|
+
steps:
|
|
140
|
+
- uses: actions/checkout@v4
|
|
141
|
+
- uses: invarnhq/cibuild@v1
|
|
142
|
+
with:
|
|
143
|
+
workflow: release
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
The action automatically maps GitHub context to cibuild environment variables (`GIT_BRANCH`, `GIT_COMMIT`, `BUILD_NUMBER`, `BUILD_URL`).
|
|
147
|
+
|
|
148
148
|
## Requirements
|
|
149
149
|
|
|
150
150
|
- macOS or Linux (Node.js 18+ for npm install)
|