Google Git
Sign in
apache/infrastructure-asfyaml/refs/heads/cml/apachecon/./docs/api/feature.github.html
blob: b630b4d8a88308efe2fe445834791a8987bbdddb [file]
<!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.github package &#8212; .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="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-github-package">
<h1>feature.github package<a class="headerlink" href="#feature-github-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.github.autolink">
<span id="feature-github-autolink-module"></span><h2>feature.github.autolink module<a class="headerlink" href="#module-feature.github.autolink" title="Link to this heading"></a></h2>
<p>GitHub autolink feature</p>
<dl class="py function">
<dt class="sig sig-object py" id="feature.github.autolink.autolink">
<span class="sig-prename descclassname"><span class="pre">feature.github.autolink.</span></span><span class="sig-name descname"><span class="pre">autolink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#feature.github.ASFGitHubFeature" title="feature.github.ASFGitHubFeature"><span class="pre">ASFGitHubFeature</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature.github.autolink.autolink" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-feature.github.features">
<span id="feature-github-features-module"></span><h2>feature.github.features module<a class="headerlink" href="#module-feature.github.features" title="Link to this heading"></a></h2>
<p>GitHub general features: wiki, issues, projects, discussions</p>
<dl class="py function">
<dt class="sig sig-object py" id="feature.github.features.config_features">
<span class="sig-prename descclassname"><span class="pre">feature.github.features.</span></span><span class="sig-name descname"><span class="pre">config_features</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#feature.github.ASFGitHubFeature" title="feature.github.ASFGitHubFeature"><span class="pre">ASFGitHubFeature</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature.github.features.config_features" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-feature.github.labels">
<span id="feature-github-labels-module"></span><h2>feature.github.labels module<a class="headerlink" href="#module-feature.github.labels" title="Link to this heading"></a></h2>
<p>GitHub labels feature</p>
<dl class="py function">
<dt class="sig sig-object py" id="feature.github.labels.set_labels">
<span class="sig-prename descclassname"><span class="pre">feature.github.labels.</span></span><span class="sig-name descname"><span class="pre">set_labels</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#feature.github.ASFGitHubFeature" title="feature.github.ASFGitHubFeature"><span class="pre">ASFGitHubFeature</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature.github.labels.set_labels" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-feature.github.merge_buttons">
<span id="feature-github-merge-buttons-module"></span><h2>feature.github.merge_buttons module<a class="headerlink" href="#module-feature.github.merge_buttons" title="Link to this heading"></a></h2>
<p>GitHub merge buttons</p>
<dl class="py function">
<dt class="sig sig-object py" id="feature.github.merge_buttons.enabled_merge_buttons">
<span class="sig-prename descclassname"><span class="pre">feature.github.merge_buttons.</span></span><span class="sig-name descname"><span class="pre">enabled_merge_buttons</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#feature.github.ASFGitHubFeature" title="feature.github.ASFGitHubFeature"><span class="pre">ASFGitHubFeature</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature.github.merge_buttons.enabled_merge_buttons" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-feature.github">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-feature.github" title="Link to this heading"></a></h2>
<p>This is the GitHub feature for .asf.yaml.</p>
<dl class="py function">
<dt class="sig sig-object py" id="feature.github.directive">
<span class="sig-prename descclassname"><span class="pre">feature.github.</span></span><span class="sig-name descname"><span class="pre">directive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature.github.directive" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="feature.github.JiraSpaceString">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feature.github.</span></span><span class="sig-name descname"><span class="pre">JiraSpaceString</span></span><a class="headerlink" href="#feature.github.JiraSpaceString" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Str</span></code></p>
<p>YAML validator for Jira spaces, must be uppercase alpha only.</p>
<dl class="py method">
<dt class="sig sig-object py" id="feature.github.JiraSpaceString.validate_scalar">
<span class="sig-name descname"><span class="pre">validate_scalar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chunk</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature.github.JiraSpaceString.validate_scalar" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="feature.github.ASFGitHubFeature">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feature.github.</span></span><span class="sig-name descname"><span class="pre">ASFGitHubFeature</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.github.ASFGitHubFeature" 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 GitHub feature class.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="feature.github.ASFGitHubFeature.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({Optional(&quot;description&quot;):</span> <span class="pre">Str(),</span> <span class="pre">Optional(&quot;homepage&quot;):</span> <span class="pre">Str(),</span> <span class="pre">Optional(&quot;labels&quot;):</span> <span class="pre">Seq(Str()),</span> <span class="pre">Optional(&quot;features&quot;):</span> <span class="pre">Map({Optional(&quot;wiki&quot;):</span> <span class="pre">Bool(),</span> <span class="pre">Optional(&quot;issues&quot;):</span> <span class="pre">Bool(),</span> <span class="pre">Optional(&quot;projects&quot;):</span> <span class="pre">Bool(),</span> <span class="pre">Optional(&quot;discussions&quot;):</span> <span class="pre">Bool()}),</span> <span class="pre">Optional(&quot;enabled_merge_buttons&quot;):</span> <span class="pre">Map({Optional(&quot;squash&quot;):</span> <span class="pre">Bool(),</span> <span class="pre">Optional(&quot;merge&quot;):</span> <span class="pre">Bool(),</span> <span class="pre">Optional(&quot;rebase&quot;):</span> <span class="pre">Bool()}),</span> <span class="pre">Optional(&quot;autolink_jira&quot;):</span> <span class="pre">JiraSpaceString()</span> <span class="pre">|</span> <span class="pre">Seq(JiraSpaceString())})</span></em><a class="headerlink" href="#feature.github.ASFGitHubFeature.schema" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feature.github.ASFGitHubFeature.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.github.ASFGitHubFeature.run" title="Link to this definition"></a></dt>
<dd><p>GitHub features</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="feature.github.ASFGitHubFeature.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.github.ASFGitHubFeature.env" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="feature.github.ASFGitHubFeature.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">'github'</span></em><a class="headerlink" href="#feature.github.ASFGitHubFeature.name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="feature.github.ASFGitHubFeature.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.github.ASFGitHubFeature.priority" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</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>
<li class="toctree-l1"><a class="reference internal" href="modules.html">infrastructure-asfyaml</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2024, ASF Infrastructure.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/feature.github.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>