@confed/sanity-types 0.1.2-2508111507 → 0.1.2-2508111525
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 +15 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -137,7 +137,8 @@ This package uses [Sanity TypeGen](https://www.sanity.io/docs/sanity-typegen) to
|
|
|
137
137
|
4. **CI/CD Trigger** → GitHub Actions workflow runs on push
|
|
138
138
|
5. **Verification** → Types regenerated in CI for verification
|
|
139
139
|
6. **Publishing** → If types changed, version bumped and published to npm
|
|
140
|
-
7. **
|
|
140
|
+
7. **Sanity Deployment** → Separate workflow deploys Sanity Studio (handled by `.github/workflows/deploy-sanity.yml`)
|
|
141
|
+
8. **No Circular Commits** → CI never commits back to your repository
|
|
141
142
|
|
|
142
143
|
The generated types provide:
|
|
143
144
|
|
|
@@ -201,17 +202,27 @@ git commit -m "your message"
|
|
|
201
202
|
|
|
202
203
|
### 4. CI/CD Integration (Automated Publishing)
|
|
203
204
|
|
|
204
|
-
This project has automated CI/CD that
|
|
205
|
+
This project has automated CI/CD workflows that handle different concerns:
|
|
206
|
+
|
|
207
|
+
**Types Publishing** (`.github/workflows/publish-types.yml`):
|
|
205
208
|
|
|
206
209
|
```yaml
|
|
207
|
-
# .github/workflows/publish-types.yml
|
|
208
210
|
# Automatically runs on schema changes:
|
|
209
211
|
# - Generates types in CI for verification
|
|
210
212
|
# - Bumps version and publishes to npm if types changed
|
|
211
213
|
# - Does NOT commit back to repository (no circular commits)
|
|
212
214
|
```
|
|
213
215
|
|
|
214
|
-
**
|
|
216
|
+
**Sanity Studio Deployment** (`.github/workflows/deploy-sanity.yml`):
|
|
217
|
+
|
|
218
|
+
```yaml
|
|
219
|
+
# Automatically deploys Sanity Studio on schema/config changes:
|
|
220
|
+
# - Builds the Sanity Studio
|
|
221
|
+
# - Deploys to Sanity hosting
|
|
222
|
+
# - Separate from types publishing workflow
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
**Note:** The CI workflows are separated by concern. Type generation and commits are handled locally via pre-commit hooks.
|
|
215
226
|
|
|
216
227
|
## Configuration
|
|
217
228
|
|