protobufdecapcms

README

Protobuf Decap CMS

Manage protobuf resources using Decap CMS.

How to

Step 1: Define your protobuf resource(s)

// 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

{
  "name": "books/alice-in-wonderland",
  "author": "Lewis Carroll",
  "title": "Alice in Wonderland",
  "create_time": "2023-01-15T13:56:45.897Z"
}

Example ≫

Step 3: Configure a Decap CMS collection

See Decap CMS Configuration: Collections.

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 ≫

Step 4: Add Decap CMS config to your proto package

See Decap CMS Configuration.

option (einride.decap.cms.v1.config) = {
  backend: {
    name: "github"
    repo: "your-org/your-repo"
    branch: "main"
  }
  media_folder: "uploads"
};

Example ≫

Step 5: Generate a Decap CMS YAML config

Use the protoc-gen-decap-cms protobuf plugin to generate a Decap CMS YAML config.

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 ≫

Step 6: Manage your resources using Decap CMS

Copy the generated config to where your Decap CMS admin application is hosted.

Example ≫

Run make develop in this repo to try out the example.

Documentation

Overview

Package protobufdecapcms is the top-level module for protobuf-decap-cms.