github.com/upcmd/up@v0.8.1-0.20230108151705-ad8b797bf04f/tests/modtests/wip/upconfig.yml (about)

     1  
     2  version: 1.0.0
     3  Verbose: v
     4  MaxCallLayers: 8
     5  RefDir: .
     6  WorkDir: cwd
     7  TaskFile: up.yml
     8  ConfigDir: .
     9  ConfigFile: upconfig.yml
    10  
    11  Modules:
    12      #clone the repo, repo name will be the module name
    13      #version==empty, then it will use master
    14      #dir==empty, it will use cloned git repo root dir
    15      #dir==empty, then mod.dir will be auto mapped to repo name
    16    - repo: https://github.com/up/sayhi.git
    17      _dir: sayhi
    18      _alias: sayhi
    19      _version: master
    20      _iid: noname
    21  
    22      #skip: if repo exist already, then skip it and do not pull, this is the default if it is not configured
    23      #manual: if repo exist already, then stop processing and fails straight away
    24      #always: if repo exist already, then delete it and repull from remote again
    25    - repo: https://github.com/up/sayhi.git
    26      pullpolicy: manual | always | skip
    27  
    28      #if both repo and dir exist, then the repo will be cloned to be named to dir name
    29    - repo: https://github.com/up/sayhi.git
    30      dir: himodule
    31      _alias: himodule
    32      _version: master
    33      _iid: noname
    34  
    35      #this is to use sub directory ./sayhi/a/b as the module location instead of root repo dir
    36    - repo: https://github.com/up/sayhi.git
    37      subdir: a/b
    38      _dir: sayhi
    39      :>alias: require setup to make it clear what the module name is
    40      _version: master
    41      _iid: noname
    42  
    43      #use version value as tag name to check it out
    44    - repo: https://github.com/up/sayhi.git
    45      version: 1.0.0
    46      _dir: sayhi
    47      _alias: sayhi
    48      _iid: noname
    49  
    50      #the alias will be a translated name to be uesd in caller's code base
    51      #eg, call: hi.SayHiTask, without alias, you will have to use sayhi.SayHiTask
    52      #this is to just to avoid duplicated repo name, eg: https://github.com/somethingeles/sayhi.git
    53    - repo: https://github.com/up/sayhi.git
    54      alias: hi
    55      _version: master
    56      _dir: sayhi
    57      _iid: noname
    58  
    59      #sha value is a specific value to checkout if it presents as version
    60    - repo: https://github.com/up/sayhello.git
    61      version: abc123e
    62      _alias: sayhello
    63      _dir: sayhello
    64      _iid: noname
    65  
    66    - #if there is no repo, then it will use the dir as module and incorporate as module
    67      #if
    68      dir: c/d
    69      :>alias: require setup to make it clear what the module name is
    70      _iid: noname
    71  
    72    - #if there is no repo, then it will use the dir as module and incorporate as module
    73      dir: c/d
    74      alias: hi
    75      _iid: noname
    76  
    77      #you can use absolute path for dir to be the location of a module
    78    - dir: /etc/c/d
    79      :>alias: require setup to make it clear what the module name is
    80      _iid: noname
    81  
    82      #iid is the instance id, which could be used in module, if it is empty then use default nonamed
    83    - dir: /etc/c/d
    84      :>alias: require setup to make it clear what the module name is
    85      iid: dev
    86