| <!doctype html> | |
| <html class="no-js" lang="en" dir="ltr"> | |
| <head> | |
| <meta charset="utf-8"> | |
| <meta http-equiv="x-ua-compatible" content="ie=edge"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |
| <title>Requesting or changing an issue and feature-request tracker for a project - Apache Infrastructure Website</title> | |
| <link href="/css/bootstrap.min.css" rel="stylesheet"> | |
| <link href="/css/fontawesome.all.min.css" rel="stylesheet"> | |
| <link href="/css/headerlink.css" rel="stylesheet"> | |
| <script src="/highlight/highlight.min.js"></script> </head> | |
| <body class="d-flex flex-column h-100"> | |
| <main class="flex-shrink-0"> | |
| <div> | |
| <!-- nav bar --> | |
| <nav class="navbar navbar-expand-lg navbar-dark bg-dark" aria-label="Fifth navbar example"> | |
| <div class="container-fluid"> | |
| <a class="navbar-brand" href="/"><img src="/images/feather.png" style="height: 32px;"/> Apache Infrastructure</a> | |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarADP" aria-controls="navbarADP" aria-expanded="false" aria-label="Toggle navigation"> | |
| <span class="navbar-toggler-icon"></span> | |
| </button> | |
| <div class="collapse navbar-collapse" id="navbarADP"> | |
| <ul class="navbar-nav me-auto mb-2 mb-lg-0"> | |
| <li class="nav-item dropdown"> | |
| <a class="nav-link dropdown-toggle" href="#" data-bs-toggle="dropdown" aria-expanded="false">About</a> | |
| <ul class="dropdown-menu"> | |
| <li><a class="dropdown-item" href="/team.html">About the team</a></li> | |
| <li><a class="dropdown-item" href="/roundtable.html">The Infrastructure Roundtable</a></li> | |
| <li><a class="dropdown-item" href="/blog/">The Infrastructure Blog</a></li> | |
| </ul> | |
| </li> | |
| <li class="nav-item"> | |
| <a class="nav-link" href="/policies.html">Policies</a> | |
| </li> | |
| <li class="nav-item dropdown"> | |
| <a class="nav-link dropdown-toggle" href="#" data-bs-toggle="dropdown" aria-expanded="false">Services and Tools</a> | |
| <ul class="dropdown-menu"> | |
| <li><a class="dropdown-item" href="/services.html">Services and Tools</a></li> | |
| <li><a class="dropdown-item" href="/machines.html">Machines and Fingerprints</a></li> | |
| <li><a class="dropdown-item" href="https://blocky.apache.org/">Blocky</a></li> | |
| <li><a class="dropdown-item" href="https://app.datadoghq.com/account/login?next=%2Finfrastructure">DataDog</a></li> | |
| <li><a class="dropdown-item" href="https://whimsy.apache.org/roster/committer/" target="_blank">Committer Search</a></li> | |
| </ul> | |
| </li> | |
| <li class="nav-item dropdown"> | |
| <a class="nav-link dropdown-toggle" href="#" data-bs-toggle="dropdown" aria-expanded="false">Documentation</a> | |
| <ul class="dropdown-menu"> | |
| <li><a class="dropdown-item" href="/doc.html">Contribute</a></li> | |
| <li><a class="dropdown-item" href="/infra-volunteer.html">Volunteer with Infra</a></li> | |
| <li><a class="dropdown-item" href="/how-to-mirror.html">Become an ASF download mirror</a></li> | |
| <li><a class="dropdown-item" href="/hosting-external-agent.html">Host a Jenkins or Buildbot agent</a></li> | |
| </ul> | |
| </li> | |
| <li class="nav-item"> | |
| <a class="nav-link" href="/stats.html">Status</a> | |
| </li> | |
| <li class="nav-item"> | |
| <a class="nav-link" href="/contact.html">Contact Us</a> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| </nav> | |
| <!-- page contents --> | |
| <div id="contents"> | |
| <div class="bg-white p-5 rounded"> | |
| <div class="col-sm-8 mx-auto"> | |
| <h1> | |
| Requesting or changing an issue and feature-request tracker for a project | |
| </h1> | |
| <p>The ASF recommends these options for tracking issues and feature requests:</p> | |
| <ul> | |
| <li><a href="https://issues.apache.org/jira" target="_blank">Jira</a></li> | |
| <li>The <a href="https://guides.github.com/features/issues/" target="_blank">GitHub issue tracking feature</a></li> | |
| </ul> | |
| <h3>Requesting a Jira instance</h3> | |
| <p>Infra itself uses Jira, so to request a Jira instance for your project, create a <a href="https://issues.apache.org/jira/browse/INFRA" target="_blank">Jira ticket</a>. Set the issue type to 'New Jira Project' and provide the necessary details:</p> | |
| <ul> | |
| <li>A list of committers with access to modify/close tickets</li> | |
| <li>A list of committers who will act as Jira administrators</li> | |
| <li>A notification scheme (to which email address do JIRA notifications go?)</li> | |
| <li>A name and description for the Jira instance</li> | |
| </ul> | |
| <h3>Response</h3> | |
| <p>Infra will respond within a couple of days, either with a request for clarification of some point or to let you know that the instance is set up and ready for your project to use.</p> | |
| <h3>Using GitHub Issue tracking</h3> | |
| <p>Enabling GitHub Issue tracking for your project is self-serve. In the .asf.yaml file for your repository, locate the <code>github</code> section and set the <code>issues</code> option to true, as in the example below. </p> | |
| <div class="highlight"><pre><span></span><code><span class="n">github</span><span class="o">:</span> | |
| <span class="w"> </span><span class="n">features</span><span class="o">:</span> | |
| <span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">Enable</span><span class="w"> </span><span class="n">wiki</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">documentation</span> | |
| <span class="w"> </span><span class="n">wiki</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> | |
| <span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">Enable</span><span class="w"> </span><span class="n">issue</span><span class="w"> </span><span class="n">management</span> | |
| <span class="w"> </span><span class="n">issues</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> | |
| <span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">Enable</span><span class="w"> </span><span class="n">projects</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">project</span><span class="w"> </span><span class="n">management</span><span class="w"> </span><span class="n">boards</span> | |
| <span class="w"> </span><span class="n">projects</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> | |
| </code></pre></div> | |
| <p>You can review your .asf.yaml settings for Git at <a href="https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features" target="_blank">Git .asf.yaml features</a>.</p> | |
| <h3>Switching from Jira to GitHub Issue tracking</h3> | |
| <p>If your project switches from Jira to GitHub for receiving issue reports and feature requests, you will want to change the existing Jira tickets to read-only, and prevent people from trying to open new tickets. This will eliminate time and effort you will otherwise have to spend on rejecting new tickets and explaining the change.</p> | |
| <p>Once GitHub issue tracking is active for the project, open what will probably be your final Jira ticket for Infra, requesting Infra to:</p> | |
| <ul> | |
| <li>Change all existing Jira tickets for the project to read-only</li> | |
| <li>Remove the project name from the drop-down list of projects that a person can choose from when creating a Jira ticket.</li> | |
| </ul> | |
| <p>Infra will let you know when this has been completed.</p> | |
| <p>We recommend that you inform your dev and user communities of the change.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <!-- footer --> | |
| <div class="row"> | |
| <div class="large-12 medium-12 columns"> | |
| <p style="font-style: italic; font-size: 0.8rem; text-align: center;"> | |
| Copyright 2024, <a href="https://www.apache.org/">The Apache Software Foundation</a>, Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br/> | |
| Apache® and the Apache feather logo are trademarks of The Apache Software Foundation... | |
| </p> | |
| </div> | |
| </div> | |
| <script type="application/ecmascript" src="/js/bootstrap.bundle.min.js" integrity="sha384-OERcA2EqjJCMA+/3y+gxIOqMEjwtxJY7qPCqsdltbNJuaOe923+mo//f6V8Qbsw3"></script> </div> | |
| </main> | |
| <script>hljs.initHighlightingOnLoad();</script> | |
| </body> | |
| </html> |