Skip to main content

Creating Workspaces

A workspace represents a collection of proto files which can be resolved within a single "namespace" using the proto files packages and imports. Administrators on a paid plan can create workspaces for use by developers in their organization by importing Github repositories.

Github Import

You can import from Github repositories that fit one of these criteria:

  • You are the owner
  • You are a collaborator
  • You have access through an organization membership

To import a Github repository, navigate to the Workspaces tab in the Dashboard, and click on the Authenticate with GitHub button. You will be asked to delegate OAuth permissions to Protocall by GitHub. We ask for the repo and user scopes, as these are the minimum required in order to import files and track future changes automatically.

After permissions are granted, you will be redirected back to the Dashboard and shown a list of repositories that can be imported. Click on the import icon for the repository you wish to import - the process shouldn't take longer than a few seconds, unless you have a very large number of proto files in the repository.

Once the import is complete, a workspace will automatically be created for all the developers in your organization, populated by the schemas imported from the repository. The name should match the repository, with the structure ${repo_owner}/${repo_name}. Now you're good to go!