.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "KAS-FOR-ALL-REPOS" "1" "Apr 10, 2024" "4.3.2" "kas"
.SH NAME
kas-for-all-repos \- kas for-all-repos plugin
.sp
This plugin implements the \fBkas for\-all\-repos\fP command.
.sp
When this command is executed, kas will checkout the repositories listed
in the chosen config file and then execute a specified command in each
repository. It can be used to query the repository status, automate
actions such as archiving the layers used in a build or to execute any
other required commands.
.sp
For example, to print the commit hashes used by each repository used in
the file \fBkas\-project.yml\fP (assuming they are all git repositories) you
could run:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
kas for\-all\-repos kas\-project.yml \(aqgit rev\-parse HEAD\(aq
.EE
.UNINDENT
.UNINDENT
.sp
The environment for executing the command in each repository is extended
to include the following variables:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBKAS_REPO_NAME\fP: The name of the current repository determined by
either the name property or by the key used for this repo in the config
file.
.IP \(bu 2
\fBKAS_REPO_PATH\fP: The path of the local directory where this
repository is checked out, relative to the directory where \fBkas\fP is
executed.
.IP \(bu 2
\fBKAS_REPO_URL\fP: The URL from which this repository was cloned, or an
empty string if no remote URL was given in the config file.
.IP \(bu 2
\fBKAS_REPO_COMMIT\fP: The commit ID which was checked out for this
repository, or an empty string if no commit was given in the config
file.
.IP \(bu 2
\fBKAS_REPO_BRANCH\fP: The branch which was checked out for this
repository, or an empty string if no branch was given in the config
file.
.IP \(bu 2
\fBKAS_REPO_TAG\fP: The tag which was checked out for this repository,
or an empty string if no tag was given in the config file.
.IP \(bu 2
\fBKAS_REPO_REFSPEC\fP: The refspec which was checked out for this
repository, or an empty string if no refspec was given in the config
file. This variable is obsolete and will be removed when support for
respec keys is removed as well. Migrate your repos to commit/branch
and use the related variables instead.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: kas for\-all\-repos [\-h] [\-\-skip SKIP] [\-\-force\-checkout] [\-\-update] [\-E]
                         [config] command
.EE
.UNINDENT
.UNINDENT
.SH POSITIONAL ARGUMENTS
.INDENT 0.0
.TP
.B config
Config file(s), separated by colon. Using .config.yaml in KAS_WORK_DIR if none is specified.
.TP
.B command
Command to be executed as a string.
.UNINDENT
.SH NAMED ARGUMENTS
.INDENT 0.0
.TP
.B \-\-skip
Skip build steps
.sp
Default: []
.TP
.B \-\-force\-checkout
Always checkout the desired commit/branch/tag of each repository, discarding any local changes
.sp
Default: False
.TP
.B \-\-update
Pull new upstream changes to the desired branch even if it is already checked out locally
.sp
Default: False
.TP
.B \-E, \-\-preserve\-env
Keep current user environment block
.sp
Default: False
.UNINDENT
.SH KAS
.sp
Part of the \fBkas(1)\fP suite.
.SH AUTHOR
Daniel Wagner, Jan Kiszka, Claudius Heine
.SH COPYRIGHT
Siemens AG, 2017-2024
.\" Generated by docutils manpage writer.
.