| <!DOCTYPE html> |
| |
| <html lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <title>feature package — .asf.yaml documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" /> |
| <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" /> |
| <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" /> |
| <script src="_static/documentation_options.js?v=5929fcd5"></script> |
| <script src="_static/doctools.js?v=9bcbadda"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="mappings module" href="mappings.html" /> |
| <link rel="prev" title="asfyaml module" href="asfyaml.html" /> |
| |
| <link rel="stylesheet" href="_static/custom.css" type="text/css" /> |
| |
| |
| |
| |
| |
| </head><body> |
| |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| |
| |
| <div class="body" role="main"> |
| |
| <section id="feature-package"> |
| <h1>feature package<a class="headerlink" href="#feature-package" title="Link to this heading">¶</a></h1> |
| <section id="submodules"> |
| <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2> |
| </section> |
| <section id="module-feature.jekyll"> |
| <span id="feature-jekyll-module"></span><h2>feature.jekyll module<a class="headerlink" href="#module-feature.jekyll" title="Link to this heading">¶</a></h2> |
| </section> |
| <section id="module-feature.notifications"> |
| <span id="feature-notifications-module"></span><h2>feature.notifications module<a class="headerlink" href="#module-feature.notifications" title="Link to this heading">¶</a></h2> |
| <p>This is the notifications feature for .asf.yaml. It validates and sets up mailing list targets for repository events.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="feature.notifications.ASFNotificationsFeature"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feature.notifications.</span></span><span class="sig-name descname"><span class="pre">ASFNotificationsFeature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="asfyaml.html#asfyaml.ASFYamlInstance" title="asfyaml.ASFYamlInstance"><span class="pre">ASFYamlInstance</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaml</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">YAML</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature.notifications.ASFNotificationsFeature" title="Link to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="asfyaml.html#asfyaml.ASFYamlFeature" title="asfyaml.ASFYamlFeature"><code class="xref py py-class docutils literal notranslate"><span class="pre">ASFYamlFeature</span></code></a></p> |
| <p>.asf.yaml notifications feature class. Runs before anything else.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="feature.notifications.ASFNotificationsFeature.valid_targets"> |
| <span class="sig-name descname"><span class="pre">valid_targets</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#feature.notifications.ASFNotificationsFeature.valid_targets" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="feature.notifications.ASFNotificationsFeature.run"> |
| <span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#feature.notifications.ASFNotificationsFeature.run" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="feature.notifications.ASFNotificationsFeature.env"> |
| <span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'production'</span></em><a class="headerlink" href="#feature.notifications.ASFNotificationsFeature.env" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="feature.notifications.ASFNotificationsFeature.name"> |
| <span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'notifications'</span></em><a class="headerlink" href="#feature.notifications.ASFNotificationsFeature.name" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="feature.notifications.ASFNotificationsFeature.priority"> |
| <span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#feature.notifications.ASFNotificationsFeature.priority" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="module-feature.testfeature"> |
| <span id="feature-testfeature-module"></span><h2>feature.testfeature module<a class="headerlink" href="#module-feature.testfeature" title="Link to this heading">¶</a></h2> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="feature.testfeature.ASFTestFeature"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feature.testfeature.</span></span><span class="sig-name descname"><span class="pre">ASFTestFeature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="asfyaml.html#asfyaml.ASFYamlInstance" title="asfyaml.ASFYamlInstance"><span class="pre">ASFYamlInstance</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaml</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">YAML</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature.testfeature.ASFTestFeature" title="Link to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="asfyaml.html#asfyaml.ASFYamlFeature" title="asfyaml.ASFYamlFeature"><code class="xref py py-class docutils literal notranslate"><span class="pre">ASFYamlFeature</span></code></a></p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="feature.testfeature.ASFTestFeature.schema"> |
| <span class="sig-name descname"><span class="pre">schema</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Map({'foo':</span> <span class="pre">Str()})</span></em><a class="headerlink" href="#feature.testfeature.ASFTestFeature.schema" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="feature.testfeature.ASFTestFeature.run"> |
| <span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#feature.testfeature.ASFTestFeature.run" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="feature.testfeature.ASFTestFeature.env"> |
| <span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'production'</span></em><a class="headerlink" href="#feature.testfeature.ASFTestFeature.env" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="feature.testfeature.ASFTestFeature.name"> |
| <span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'test'</span></em><a class="headerlink" href="#feature.testfeature.ASFTestFeature.name" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="feature.testfeature.ASFTestFeature.priority"> |
| <span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#feature.testfeature.ASFTestFeature.priority" title="Link to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="module-feature"> |
| <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-feature" title="Link to this heading">¶</a></h2> |
| </section> |
| </section> |
| |
| |
| </div> |
| |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="Main"> |
| <div class="sphinxsidebarwrapper"> |
| <h1 class="logo"><a href="index.html">.asf.yaml</a></h1> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <search id="searchbox" style="display: none" role="search"> |
| <div class="searchformwrapper"> |
| <form class="search" action="search.html" method="get"> |
| <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/> |
| <input type="submit" value="Go" /> |
| </form> |
| </div> |
| </search> |
| <script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3> |
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="modules.html">infrastructure-asfyaml</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="asfyaml.html">asfyaml module</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">feature package</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="mappings.html">mappings module</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dataobjects.html">version control classes</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| <div class="relations"> |
| <h3>Related Topics</h3> |
| <ul> |
| <li><a href="index.html">Documentation overview</a><ul> |
| <li><a href="modules.html">infrastructure-asfyaml</a><ul> |
| <li>Previous: <a href="asfyaml.html" title="previous chapter">asfyaml module</a></li> |
| <li>Next: <a href="mappings.html" title="next chapter">mappings module</a></li> |
| </ul></li> |
| </ul></li> |
| </ul> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="footer"> |
| ©2024, ASF Infrastructure. |
| |
| | |
| Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a> |
| & <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a> |
| |
| | |
| <a href="_sources/feature.rst.txt" |
| rel="nofollow">Page source</a> |
| </div> |
| |
| |
| |
| |
| </body> |
| </html> |
