devgrid.yml

The devgrid.yml file is what directs the CLI commands how to sync with the DevGrid Platform. An example file would look like:

# devgrid.yml
project:
  appId: abc123
  components:
  - name: my-cool-api
    shortId: ab123 #component generated short id. 
    api: swagger.yml #path to your API Definition
    manifest: package.json #path to application manifest (pom.xml, package.json, etc.) 
    attributes:
      custom_id: xyz456
      someValueSetViaEnvVariables: {{ .MY_CUSTOM_ENV_VALUE }}
    dependencies: #designate component dependencies
       - to: some-component-shortId
         attributes:
           custom_id: xyz456
       - to: another-component-shortId
    technologies:
      - nodejs #technology shortId
      - python 
    relationships:
      - type: component-has-dependency
        to: qwe312
# todo - add in write up of how to do component type and other relationships