https://github.com/einride/protobuf-decap-cms
Manage protobuf resources using Decap CMS.
https://github.com/einride/protobuf-decap-cms
Last synced: 2 months ago
JSON representation
Manage protobuf resources using Decap CMS.
- Host: GitHub
- URL: https://github.com/einride/protobuf-decap-cms
- Owner: einride
- License: mit
- Created: 2022-12-13T14:21:21.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T07:18:01.000Z (4 months ago)
- Last Synced: 2025-01-03T08:23:12.210Z (4 months ago)
- Language: Go
- Homepage:
- Size: 297 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-decap-cms - protobuf-decap-cms - Manage protobuf resources using Decap CMS. (Miscellaneous)
README
# Protobuf Decap CMS
Manage protobuf resources using [Decap CMS](https://decapcms.org/).
## How to
### Step 1: Define your protobuf resource(s)
```proto
// A book.
message Book {
option (google.api.resource) = {
type: "decap-cms-example.einride.tech/Book",
pattern: "books/{book}"
};
// The resource name of the book.
// Book names have the form `books/{book_id}`.
string name = 1;
// The timestamp the body build was created.
google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// The name of the book author.
string author = 3 [(google.api.field_behavior) = REQUIRED];
// The title of the book.
string title = 4 [(google.api.field_behavior) = REQUIRED];
// Value indicating whether the book has been read.
bool read = 5;
}
```
### Step 2: Add protobuf messages as JSON files
```json
{
"name": "books/alice-in-wonderland",
"author": "Lewis Carroll",
"title": "Alice in Wonderland",
"create_time": "2023-01-15T13:56:45.897Z"
}
```
[Example ≫](./example/books/books-alice-in-wonderland.json)
### Step 3: Configure a Decap CMS collection
See
[Decap CMS Configuration: Collections](https://decapcms.org/docs/configuration-options/?#collections).
```proto
message Book {
option (google.api.resource) = {
type: "decap-cms-example.einride.tech/Book",
pattern: "books/{book}"
};
option (einride.decap.cms.v1.collection) = {
name: "books"
label: "Books"
label_singular: "Book"
folder: "example/books"
create: true
identifier_field: "name"
format: "json"
description: "Books"
summary: "{{title}}"
editor: {preview: false}
};
// ...
}
```
[Example ≫](./proto/einride/decap/cms/example/v1/book.proto)
### Step 4: Add Decap CMS config to your proto package
See [Decap CMS Configuration](https://decapcms.org/docs/configuration-options/).
```proto
option (einride.decap.cms.v1.config) = {
backend: {
name: "github"
repo: "your-org/your-repo"
branch: "main"
}
media_folder: "uploads"
};
```
[Example ≫](./proto/einride/decap/cms/example/v1/config.proto)
### Step 5: Generate a Decap CMS YAML config
Use the [protoc-gen-decap-cms](./cmd/protoc-gen-decap-cms) protobuf plugin to
generate a Decap CMS YAML config.
```yaml
version: v1
managed:
enabled: true
go_package_prefix:
default: go.einride.tech/protobuf-decap-cms/proto/gen/cms
except:
- buf.build/googleapis/googleapis
plugins:
- name: decap-cms
out: proto/gen/cms
opt: module=go.einride.tech/protobuf-decap-cms/proto/gen/cms
```
[Example ≫](./proto/buf.gen.example.yaml)
### Step 6: Manage your resources using Decap CMS
Copy the generated config to where your Decap CMS admin application is hosted.
[Example ≫](./example/admin)
Run `make develop` in this repo to try out the example.