Content of a resource in resources.yml

- name: git resource # name of the resource
  repository: https://github.com/concourse/git-resource # link to the Github repository holding the source code of the resource
  desc: Tracks the commits in a git repository. # optional, briefly describe the resource
  get: yes # optional, can this resource be used as get?
  put: yes # optional, can this resource be used as put?
  verified: true # optional
  categories: # optional, collection of categories the resource belongs to
    - Version Control
  version: v1.5.0 # optional, last version

• name and repository are the only mandatory fields for a resource, from them we derive
  • unique identifier for resources (used as URL)
  • github user/organisation (eg concourse)
  • github user/organisation link (eg https://github.com/concourse)
  • retrieve the readme from github (main readme of the repository)
• desc, get, put, categories, version, and verified are editorial
  • desc (string): short description of the resource, can be retrieved from the readme, at the moment descriptions that are too long can break the visualisation of the tile
  • get, put (bool): which operations are implemented (or supported) for the resource, can be deducted from the readme
  • categories ([]string): need to be assigned to resources manually, at the moment not all resources are assigned a category (a document exists with resources assigned to categories - this came out of our user interviews)
  • version (string): last version of the resource, this can be automated retrieving the data from github or later from docker - at the moment needs to be manually deducted from github
  • verified (bool): it is up to the Concourse team to decide which resources to set this to be true for (at the moment only Concourse resources have this label)