Skip to content

apiVersion v1

Gear file structure

git-system-follower-package/
├─ package.yaml
└─ scripts/
   ├─ <version>/
   │   ├─ delete.py
   │   ├─ init.py
   │   ├─ update.py
   │   └─ templates/
   │      ├─ <template>/
   │      │  ├─ cookiecutter.json
   │      │  └─ {{ cookiecutter.gsf_repository_name }}/
   │      │     └─ <template files>
   │      └─ <other template>
   │         └─ ...
   └─ <next version>/
      └─ ...

Description package.yaml file sections

Section Description Available types Example
apiVersion package.yaml api version for git-system-follower to understand how to work with this Gear v1 v1
type Gear type gitlab-ci-pipeline gitlab-ci-pipeline
name Gear name any my-first-gear
version Gear version any 1.0.0
dependencies List of dependencies specified as docker images any artifactory.company.com/path-to/your-image:1.0.0

Example

With dependency

apiVersion: v1
type: gitlab-ci-pipeline
name: my-gear
version: 1.0.0
dependencies:
  - artifactory.company.com/path-to/my-another-image:1.0.0

Without dependencies

apiVersion: v1
type: gitlab-ci-pipeline
name: my-gear
version: 1.0.0