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

     1  
     2  version: 1.0.0
     3  Verbose: vvv
     4  MaxCallLayers: 8
     5  RefDir: .
     6  TaskFile: up.yml
     7  ConfigDir: .
     8  ConfigFile: upconfig.yml
     9  
    10  Modules:
    11    #clone the repo, repo name will be the module name
    12    #version==empty, then it will use master
    13    #dir==empty, it will use cloned git repo root dir
    14    #dir==empty, then mod.dir will be auto mapped to repo name
    15    - repo: https://github.com/upcmd/hello-module.git
    16      _dir: sayhi
    17      _alias: sayhi
    18      _version: master
    19      _iid: noname
    20  
    21      #allowed: manual | always | skip
    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/upcmd/module-a.git
    26      pullpolicy: always
    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/upcmd/hello-module.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/upcmd/module-b.git
    37      subdir: a/b
    38      alias: module-b-subdir
    39      _dir: sayhi
    40      :>alias: require setup to make it clear what the module name is
    41      _version: master
    42      _iid: noname
    43  
    44      #use version value as tag name to check it out
    45    - repo: https://github.com/upcmd/module-c.git
    46      version: 1.0.0
    47      _dir: sayhi
    48      _alias: sayhi
    49      _iid: noname
    50  
    51      #the alias will be a translated name to be uesd in caller's code base
    52      #eg, call: hi.SayHiTask, without alias, you will have to use sayhi.SayHiTask
    53      #this is to just to avoid duplicated repo name, eg: https://github.com/somethingeles/sayhi.git
    54    - repo: https://github.com/upcmd/hello-module.git
    55      alias: hi
    56      _version: master
    57      _dir: sayhi
    58      _iid: noname
    59  
    60      #sha value is a specific value to checkout if it presents as version
    61    - repo: https://github.com/up/sayhello.git
    62      version: abc123e
    63      _alias: sayhello
    64      _dir: sayhello
    65      _iid: noname
    66  
    67    - #if there is no repo, then it will use the dir as module and incorporate as module
    68      #if
    69      dir: c/d
    70      alias: a_relative_dir_module
    71      :>alias: require setup to make it clear what the module name is
    72      _iid: noname
    73  
    74    - #if there is no repo, then it will use the dir as module and incorporate as module
    75      dir: c/d
    76      alias: himod
    77      _iid: noname
    78  
    79      #you can use absolute path for dir to be the location of a module
    80    - dir: /etc/c/d
    81      :>alias: require setup to make it clear what the module name is
    82      alias: absolute_path_module
    83      _iid: noname
    84  
    85      #iid is the instance id, which could be used in module, if it is empty then use default nonamed
    86    - dir: /etc/c/d
    87      :>alias: require setup to make it clear what the module name is
    88      alias: absolute_path_with_iid_module
    89      iid: dev
    90