| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="../"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>compose - Compose the output of multiple elements — BuildStream 2.2.0+3.gc7274d41d documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" /> |
| <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" /> |
| |
| |
| <!--[if lt IE 9]> |
| <script src="../_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| <script src="../_static/jquery.js?v=5d32c60e"></script> |
| <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="../_static/documentation_options.js?v=f96d84dc"></script> |
| <script src="../_static/doctools.js?v=9a2dae69"></script> |
| <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="../_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="script - Run scripts to create output" href="script.html" /> |
| <link rel="prev" title="import - Import sources directly" href="import.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../index.html" class="icon icon-home"> |
| BuildStream |
| </a> |
| <div class="version"> |
| 2.2.0+3.gc7274d41d |
| </div> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../main_about.html">About</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../main_install.html">Installing from Source</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../main_using.html">Using</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../main_core.html">Reference</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../core_format.html">Project format</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../core_plugins.html">Plugin specific documentation</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="../core_plugins.html#elements">Elements</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="stack.html">stack - Symbolic Element for dependency grouping</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="import.html">import - Import sources directly</a></li> |
| <li class="toctree-l4 current"><a class="current reference internal" href="#">compose - Compose the output of multiple elements</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="script.html">script - Run scripts to create output</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="link.html">link - Link elements</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="junction.html">junction - Integrate subprojects</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="filter.html">filter - Extract a subset of files from another element</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="manual.html">manual - Manual build element</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../core_plugins.html#sources">Sources</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../core_plugins.html#external-plugins">External plugins</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../core_framework.html">Plugin API reference</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../core_additional.html">Additional writings</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../buildstream.html">buildstream package</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../main_porting.html">Porting guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../CONTRIBUTING.html">Contributing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../main_architecture.html">Architecture</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../main_glossary.html">Glossary</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">BuildStream</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="../main_core.html">Reference</a></li> |
| <li class="breadcrumb-item"><a href="../core_plugins.html">Plugin specific documentation</a></li> |
| <li class="breadcrumb-item active">compose - Compose the output of multiple elements</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../_sources/elements/compose.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="compose-compose-the-output-of-multiple-elements"> |
| <span id="module-elements.compose"></span><h1>compose - Compose the output of multiple elements<a class="headerlink" href="#compose-compose-the-output-of-multiple-elements" title="Link to this heading"></a></h1> |
| <p>This element creates a selective composition of its dependencies.</p> |
| <p>This is normally used at near the end of a pipeline to prepare |
| something for later deployment.</p> |
| <p>Since this element’s output includes its dependencies, it may only |
| depend on elements as <cite>build</cite> type dependencies.</p> |
| <dl> |
| <dt>The default configuration and possible options are as such:</dt><dd><div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span> |
| <span class="c1"># you may not use this file except in compliance with the License.</span> |
| <span class="c1"># You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing, software</span> |
| <span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="c1"># See the License for the specific language governing permissions and</span> |
| <span class="c1"># limitations under the License.</span> |
| |
| <span class="c1"># Compose element configuration</span> |
| <span class="nt">config</span><span class="p">:</span> |
| |
| <span class="w"> </span><span class="c1"># Whether to run the integration commands for the</span> |
| <span class="w"> </span><span class="c1"># staged dependencies.</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="nt">integrate</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span> |
| |
| <span class="w"> </span><span class="c1"># A list of domains to include from each artifact, as</span> |
| <span class="w"> </span><span class="c1"># they were defined in the element's 'split-rules'.</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="c1"># Since domains can be added, it is not an error to</span> |
| <span class="w"> </span><span class="c1"># specify domains which may not exist for all of the</span> |
| <span class="w"> </span><span class="c1"># elements in this composition.</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="c1"># The default empty list indicates that all domains</span> |
| <span class="w"> </span><span class="c1"># from each dependency should be included.</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="nt">include</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span> |
| |
| <span class="w"> </span><span class="c1"># A list of domains to exclude from each artifact, as</span> |
| <span class="w"> </span><span class="c1"># they were defined in the element's 'split-rules'.</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="c1"># In the case that a file is spoken for by a domain</span> |
| <span class="w"> </span><span class="c1"># in the 'include' list and another in the 'exclude'</span> |
| <span class="w"> </span><span class="c1"># list, then the file will be excluded.</span> |
| <span class="w"> </span><span class="nt">exclude</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span> |
| |
| <span class="w"> </span><span class="c1"># Whether to include orphan files which are not</span> |
| <span class="w"> </span><span class="c1"># included by any of the 'split-rules' present on</span> |
| <span class="w"> </span><span class="c1"># a given element.</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="nt">include-orphans</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span> |
| </pre></div> |
| </div> |
| </dd> |
| </dl> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="import.html" class="btn btn-neutral float-left" title="import - Import sources directly" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="script.html" class="btn btn-neutral float-right" title="script - Run scripts to create output" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2017-2022, The Apache Software Foundation.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
