NAME

       kas-lock - kas lock plugin

SYNOPSIS

          kas lock [-h] [--skip STEP] [--force-checkout] [--update] [--indent INDENT]
                   [config]

DESCRIPTION

       Create and update kas project lockfiles.

       This plugin implements the kas lock command.

       When  this  command  is  executed  a locking spec is created which only contains the exact
       commit of each repository. This is used to pin the commit of floating branches  and  tags,
       while still keeping an easy update path. The lockfile is created next to the first file on
       the    kas    cmdline.     For     details     on     the     locking     support,     see
       kas.includehandler.IncludeHandler.

       Please note:

       • all referenced repositories are checked out to resolve cross-repo configs

       • all branches are resolved before patches are applied

       Example   (call   again   to   regenerate   lockfile).    The   lockfile   is  created  as
       kas-project.lock.yml:

          kas lock --update kas-project.yml

       The generated lockfile will automatically be used to pin the revisions:

          kas build kas-project.yml

       Note, that the lockfiles should be checked-in into the VCS.

OPTIONS

       Positional Arguments

       config Config file(s), separated by colon. Using .config.yaml in KAS_WORK_DIR if  none  is
              specified.

       Named Arguments

       --skip=[]
              Skip build steps. To skip more than one step, use this argument multiple times.

              Possible   choices:   setup_dir,   setup_home,  init_setup_repos,  repo_setup_loop,
              finish_setup_repos,     repos_checkout,     repos_apply_patches,     setup_environ,
              write_bbconfig

       --force-checkout=False
              Always  checkout  the  desired commit/branch/tag of each repository, discarding any
              local changes

       --update=False
              Pull new upstream changes to the desired branch even if it is already  checked  out
              locally

       --indent=4
              Line indent (# of spaces, default: 4)

SEE ALSO

       kas-project-config(1), kas-dump(1), kas-build(1)

KAS

       Part of the kas(1) suite.

AUTHOR

       Daniel Wagner, Jan Kiszka, Claudius Heine

COPYRIGHT

       Siemens AG, 2017-2024