Go to file
Jasper Orschulko 15de0142d4 Add environment variable SSH_PRIVATE_KEY_FILE
Additionally to the variable SSH_PRIVATE_KEY, which can be used to
reference a private key saved as a string within a variable (the previous
documentation falsely stated, that it references a path and has been
adjusted), the new variable SSH_PRIVATE_KEY_FILE can now be used to reference
the path to a file containing the private key.

Signed-off-by: Jasper Orschulko <jasper@fancydomain.eu>
[Jan: Fix logic for detecting set env vars]
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-07-10 11:25:40 +02:00
.github Use issue template to point people to the list 2021-03-25 19:43:01 +01:00
docs Add environment variable SSH_PRIVATE_KEY_FILE 2021-07-10 11:25:40 +02:00
kas Add environment variable SSH_PRIVATE_KEY_FILE 2021-07-10 11:25:40 +02:00
scripts checkcode: Address shellcheck warnings 2021-01-29 21:00:08 +01:00
tests repos: strip dot from layer name 2021-05-05 15:43:58 +02:00
.dockerignore add dockerignore 2017-06-26 09:29:07 +02:00
.flake8 flake8: Ignore obsolete warning W503 2020-11-13 20:54:20 +01:00
.gitignore Add release artifact to .gitignore 2020-11-20 12:05:51 +01:00
CHANGELOG.md Release 2.5 2021-05-26 07:27:23 +02:00
container-entrypoint kas-container: Add support for checkout and for-all-repos 2021-05-20 16:39:39 +02:00
CONTRIBUTING.md CONTRIBUTING: Drop reference to non-existing maintainer list 2020-12-17 18:13:19 +01:00
Dockerfile Dockerfile: move sudo to standard Dockerfile 2021-04-27 07:25:59 +02:00
Dockerfile.isar Dockerfile: move sudo to standard Dockerfile 2021-04-27 07:25:59 +02:00
kas-container kas-container: Update and improve help output 2021-06-29 13:45:40 +02:00
kas-docker rename kas-docker to kas-container, leave symlink in place 2020-09-29 08:30:10 +02:00
LICENSE Correct grammar, spelling and copyright year in files 2018-09-05 12:46:35 +02:00
README.rst Switch to github workflow 2020-09-24 13:13:12 +02:00
requirements_rtd.txt requirements_rtd: Add jsonschema module 2020-06-02 10:36:54 +02:00
run-kas Correct grammar, spelling and copyright year in files 2018-09-05 12:46:35 +02:00
setup.py setup: Set upper version limit for dependencies 2021-02-24 09:01:08 +01:00

Setup tool for bitbake based projects
=====================================

+--------------------+
|    Build Status    |
+====================+
| |workflow-master|_ |
+--------------------+
| |workflow-next|_   |
+--------------------+

.. |workflow-master| image:: https://github.com/siemens/kas/workflows/master/badge.svg
.. _workflow-master: https://github.com/siemens/kas/actions?query=workflow%3Amaster
.. |workflow-next| image:: https://github.com/siemens/kas/workflows/next/badge.svg
.. _workflow-next: https://github.com/siemens/kas/actions?query=workflow%3Anext

This tool provides an easy mechanism to setup bitbake based
projects.

The OpenEmbedded tooling support starts at step 2 with bitbake. The
downloading of sources and then configuration has to be done by
hand. Usually, this is explained in a README. Instead kas is using a
project configuration file and does the download and configuration
phase.

Key features provided by the build tool:

- clone and checkout bitbake layers
- create default bitbake settings (machine, arch, ...)
- launch minimal build environment, reducing risk of host contamination
- initiate bitbake build process

See the `kas documentation <https://kas.readthedocs.io>`_ for further details.