protop.json

The protop.json file (also called the manifest) is created in your project's root directory when you initialize a project, but you can also just create it manually. An example of a manifest might look like this:

{
"name": "awesome-protos",
"version": "0.1.0",
"organization": "awesomelabs",
"dependencies": {
"awesomelabs/numbers": "git:https://github.com/protop-io/numbers-protos@master",
"awesomelabs/numbers-hub": "gh:protop-io/numbers-protos",
"awesomelabs/numbers-bucket": "bb:protop-io/numbers-protos@feature/my-feature-branch",
"awesomelabs/numbers-lab": "gl:protop-io/numbers-protos@development"
}
}

Properties

{

"name":

The project name.

Type: string

Required: false

"organization":

The project's organization id.

Type: string

Required: false

"version":

The package version.

Type: string

Required: false

"dependencies":

External dependencies of the project.

Type: object

Required: false

Dependencies can be required by name (e.g. <name/organization>) mapped to a specific git source.

Git Source

Any git repository can be a source if it contains a valid protop.json in its root directory. This requires the full URL of the repository, prefixed with "git". For example: git:https://github.com/protop-io/numbers-protos.

GitHub Source

A git repository hosted on GitHub can be used with the "gh" prefix and the repository path. For example: gh:protop-io/numbers-protos.

Bitbucket Source

A git repository hosted on Bitbucket can be used with the "bb" prefix and the repository path. For example: bb:protop-io/numbers-protos.

Gitlab Source

A git repository hosted on Gitlab can be used with the "gl" prefix and the repository path. For example: gl:protop-io/numbers-protos.

}