PTU5KAS

Fork of https://github.com/siemens/kas.git

Go to file

Paul Barker bcb748c22a kas: Factor out common setup & cleanup steps The list of steps to be executed within a macro is split into setup commands, main commands and cleanup commands to ensure that new steps are added to the appropriate place in the execution order by plugins. By default, the setup and cleanup commands are set to the default list of steps which the build and shell plugins have in common. It's expected that most future plugins will also share these common setup and cleanup steps but we do provide arguments to the Macro initialiser to skip these if customisation is needed. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>		2020-11-13 20:56:52 +01:00
.github/workflows	ci: Add Python 3.9 to test matrix	2020-11-13 08:02:24 +01:00
docs	plugins: Improve documentation of existing modules	2020-11-13 07:45:07 +01:00
kas	kas: Factor out common setup & cleanup steps	2020-11-13 20:56:52 +01:00
scripts	kas-container: make container image variables overwritable	2020-09-29 08:35:04 +02:00
tests	tests: small correction to git args	2020-11-09 08:57:04 +01: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	Expanded and documented .gitignore	2017-06-28 15:12:15 +02:00
CHANGELOG.md	Release 2.2	2020-08-20 09:17:34 +02:00
container-entrypoint	rename docker-entrypoint to container-entrypoint	2020-09-29 08:32:57 +02:00
CONTRIBUTING.md	CONTRIBUTING: add subscription links for list to document	2018-12-17 10:58:33 +01:00
Dockerfile	Dockerfile: add zstd	2020-11-02 09:10:37 +01:00
Dockerfile.isar	rename docker-entrypoint to container-entrypoint	2020-09-29 08:32:57 +02:00
kas-container	kas-container: allow the `-d`/`-v` of kas-container to set `-d` on kas	2020-10-22 08:40:37 +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	Declare Python 3.9 compatibility	2020-11-13 08:56:31 +01:00

README.rst

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.