Inhoudspoort
1 min leestijd
opencx content gate valideert je lokale contentbestanden en vergelijkt ze met de remote om afwijkingen te detecteren. Het combineert lokale validatie (content check) met een remote diff in één enkele opdracht.
Gebruik
bash
opencx content gate
Vereist authenticatie via OPENCX_API_KEY.
Hoe Het Verschilt van Check
content check | content gate | |
|---|---|---|
| Lokale validatie | Ja | Ja |
| Remote afwijkingsdetectie | Nee | Ja |
| Vereist auth | Nee | Ja |
| Gebruikssituatie | Lokale ontwikkeling, snelle validatie | CI-pijplijnen, pre-deploy gates |
content check valideert de bestandsstructuur, frontmatter en naamgevingsconventies lokaal. content gate voert dezelfde validatie uit, haalt vervolgens de remote status op en vergelijkt deze om eventuele verschillen te detecteren.
Exitcodes
| Code | Betekenis |
|---|---|
| 0 | Content is geldig en gesynchroniseerd |
| 1 | Validatie mislukt of content is niet gesynchroniseerd |
JSON-uitvoer
Gebruik --json voor machinaal leesbare uitvoer.
bash
opencx content gate --json
Uitvoerschema:
json
{
"valid": true,
"synced": true,
"check": {
"valid": true,
"errors": [],
"stats": {
"categories": 3,
"articles": 12
}
},
"diff": {
"hasChanges": false
}
}
Wanneer validatie mislukt, is synced false en is diff null:
json
{
"valid": false,
"synced": false,
"check": {
"valid": false,
"errors": [
{ "file": "docs/getting-started/intro.md", "message": "Verplicht veld ontbreekt: titel" }
]
},
"diff": null
}
Wanneer Gate vs Check te Gebruiken
- Gebruik
content checktijdens lokale ontwikkeling voor snelle feedback. - Gebruik
content gatein CI-pijplijnen om ervoor te zorgen dat content zowel geldig als gesynchroniseerd is voordat deze wordt ingezet. - Gebruik
content checkin pull request-workflows waar je alleen validatie nodig hebt zonder remote vergelijking.