<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd"> | |
<!-- ====================================================================== --> | |
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! --> | |
<!-- ====================================================================== --> | |
<html> | |
<head> | |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> | |
<style type="text/css">@import "stylesheets/base.css";</style> | |
<meta name="author" value=" Apache UIMA Documentation Team"> | |
<meta name="email" value="dev@uima.apache.org"> | |
<title>Apache UIMA - Converting project to GIT</title> | |
<!-- Begin Cookie Consent plugin by Silktide - https://silktide.com/cookieconsent --> | |
<!-- Commented out because implied consent is not compatible with GDPR --> | |
<!-- | |
<script type="text/javascript"> | |
window.cookieconsent_options = {"message":"This website uses cookies to ensure you get the best experience on our website","dismiss":"Got it!","learnMore":"More info","link":"https://uima.apache.org/privacy-policy.html","theme":"dark-bottom"}; | |
</script> | |
<script type="text/javascript" src="/cookieconsent2/cookieconsent.min.js"></script> | |
--> | |
<!-- End Cookie Consent plugin --> | |
<!-- Begin Google Analytics --> | |
<!-- Commented out because GA requires consent according to GDPR --> | |
<!-- | |
<script> | |
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ | |
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), | |
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) | |
})(window,document,'script','//www.google-analytics.com/analytics.js','ga'); | |
ga('create', 'UA-70846351-1', 'auto'); | |
ga('set', 'anonymizeIp', true); | |
ga('send', 'pageview'); | |
</script> | |
--> | |
<!-- End Google Analytics --> | |
</head> | |
<body> | |
<div class="topLogos"> | |
<table border="0" width="100%" cellspacing="0"> | |
<!-- TOP IMAGE --> | |
<tr> | |
<td align='LEFT'> | |
<a href="index.html"> | |
<img style="border: 1px solid black;" src="./images/UIMA_banner2tlpTm.png" alt="UIMA project logo" border="0"/> | |
</a> | |
</td> | |
<td align='CENTER'> | |
<div class="pageBanner">Converting project to GIT</div> | |
</td> | |
<td align='RIGHT'> | |
<a href="https://www.apache.org"> | |
<img src="./images/asf-logo-on-white-smallTm.png" alt="Apache UIMA" border="0"/> | |
</a> | |
</td> | |
</tr> | |
</table> | |
<hr noshade="" size="1"/> | |
</div> | |
<table border="0" width="100%" cellspacing="4"> | |
<tr> | |
<td align='RIGHT' colspan="2"> | |
<form method="get" action="https://www.google.com/search"> | |
Search the site | |
<input type="text" name="q" size="25" maxlength="255" value="" /> | |
<input type="hidden" name="sitesearch" value="https://uima.apache.org/" /> | |
<input name="Search" value="Search Site" type="submit"/> | |
</form> | |
</td> | |
</tr> | |
<tr> <!-- LEFT SIDE NAVIGATION --> | |
<td width="20%" valign="top"> | |
<!-- regular menu --> | |
<div class="navBar"> | |
<br/> | |
<div class="navBarItem"> <div class="navPartHeading">General</div> | |
</div> | |
<div class="navBar"> | |
<div class="navBarItem"> <a href="./index.html">Home</a> | |
</div> | |
<div class="navBarItem"> <a href="./downloads.cgi">Downloads</a> | |
</div> | |
<div class="navBarItem"> <a href="./documentation.html">Documentation</a> | |
</div> | |
<div class="navBarItem"> <a href="./news.html">News</a> | |
</div> | |
<div class="navBarItem"> <a href="./publications.html">Publications</a> | |
</div> | |
<br style="line-height: .5em"/> | |
<div class="navBarItem"> <a href="https://issues.apache.org/jira/browse/uima" target="_blank" rel="noopener">Issue tracker <img src="images/offsitelink.png"/></a> | |
</div> | |
<div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/" target="_blank" rel="noopener">Wiki <img src="images/offsitelink.png"/></a> | |
</div> | |
<br style="line-height: .5em"/> | |
<div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/Powered+by+Apache+UIMA" target="_blank" rel="noopener">Powered By UIMA <img src="images/offsitelink.png"/></a> | |
</div> | |
</div> | |
<br/> | |
<div class="navBarItem"> <div class="navPartHeading">Community</div> | |
</div> | |
<div class="navBar"> | |
<div class="navBarItem"> <a href="./get-involved.html">Get Involved</a> | |
</div> | |
<div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a> | |
</div> | |
<div class="navBarItem"> <a href="./contribution-policy.html">Contribution Policies</a> | |
</div> | |
<div class="navBarItem"> <a href="./faq.html">FAQ</a> | |
</div> | |
<div class="navBarItem"> <a href="./project-guidelines.html">Project Guidelines</a> | |
</div> | |
</div> | |
<br/> | |
<div class="navBarItem"> <div class="navPartHeading">Scaleout Frameworks</div> | |
</div> | |
<div class="navBar"> | |
<div class="navBarItem"> <a href="./doc-uimaas-what.html">UIMA-AS</a> | |
</div> | |
<div class="navBarItem"> <a href="./doc-uimaducc-whatitam.html">UIMA-DUCC</a> | |
</div> | |
<div class="navBarItem"> <a href="./doc-uimaducc-demo.html">..Demo Page</a> | |
</div> | |
<div class="navBarItem"> <a href="http://uima-ducc-demo.apache.org:42133" target="_blank" rel="noopener">..Demo Live <img src="images/offsitelink.png"/></a> | |
</div> | |
</div> | |
<br/> | |
<div class="navBarItem"> <div class="navPartHeading">Components & Tools</div> | |
</div> | |
<div class="navBar"> | |
<div class="navBarItem"> <a href="./sandbox.html#uima-addons-annotators">Annotators</a> | |
</div> | |
<div class="navBarItem"> <a href="./toolsServers.html">Tools & Servers</a> | |
</div> | |
<div class="navBarItem"> <a href="./sandbox.html">Addons and Sandbox</a> | |
</div> | |
<div class="navBarItem"> <a href="./ruta.html">UIMA Ruta</a> | |
</div> | |
<div class="navBarItem"> <a href="./uimafit.html">uimaFIT</a> | |
</div> | |
<div class="navBarItem"> <a href="./external-resources.html">External Resources</a> | |
</div> | |
</div> | |
<br/> | |
<div class="navBarItem"> <div class="navPartHeading">Development</div> | |
</div> | |
<div class="navBar"> | |
<div class="navBarItem"> <a href="./dev-quick.html">Quick Start: building</a> | |
</div> | |
<div class="navBarItem"> <a href="./building-uima.html">Building from Source</a> | |
</div> | |
<div class="navBarItem"> <a href="./one-time-setup.html">One-time setups</a> | |
</div> | |
<div class="navBarItem"> <a href="./svn.html">Source Code</a> | |
</div> | |
<div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a> | |
</div> | |
<div class="navBarItem"> <a href="https://www.apache.org/security/committers.html" target="_blank" rel="noopener">Doing a CVE (Apache) <img src="images/offsitelink.png"/></a> | |
</div> | |
<div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</a> | |
</div> | |
<div class="navBarItem"> <a href="./git.html">GIT</a> | |
</div> | |
<div class="navBarItem"> <a href="./codeConventions.html">Code Conventions</a> | |
</div> | |
<div class="navBarItem"> <a href="./uima-specification.html">UIMA Specification (OASIS)</a> | |
</div> | |
<div class="navBarItem"> <a href="./team-list.html">Project Team</a> | |
</div> | |
<div class="navBarItem"> <a href="./maven-design.html">Maven Use</a> | |
</div> | |
<div class="navBarItem"> <a href="./updating-website.html">Updating this Website</a> | |
</div> | |
</div> | |
<br/> | |
<div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div> | |
</div> | |
<div class="navBar"> | |
<div class="navBarItem"> <a href="./coling14.html">COLING 2014</a> | |
</div> | |
<div class="navBarItem"> <a href="./gscl13.html">GSCL 2013</a> | |
</div> | |
<div class="navBarItem"> <a href="./iks09.html">IKS 2009</a> | |
</div> | |
<div class="navBarItem"> <a href="./gscl09.html">GSCL 2009</a> | |
</div> | |
<div class="navBarItem"> <a href="./lsm09.html">LSM 2009</a> | |
</div> | |
<div class="navBarItem"> <a href="./lrec08.html">LREC 2008</a> | |
</div> | |
<div class="navBarItem"> <a href="./gldv07.html">GLDV 2007</a> | |
</div> | |
</div> | |
<br/> | |
<div class="navBarItem"> <div class="navPartHeading">ASF</div> | |
</div> | |
<div class="navBar"> | |
<div class="navBarItem"> <a href="https://www.apache.org/licenses/" target="_blank" rel="noopener">License <img src="images/offsitelink.png"/></a> | |
</div> | |
<div class="navBarItem"> <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener">ASF Sponsors <img src="images/offsitelink.png"/></a> | |
</div> | |
<div class="navBarItem"> <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener">ASF Sponsorship <img src="images/offsitelink.png"/></a> | |
</div> | |
<div class="navBarItem"> <a href="./security_report">Security</a> | |
</div> | |
</div> | |
</div> | |
</td> | |
<td width="80%" align="left" valign="top"> | |
<div class="sectionTable"> | |
<table class="sectionTable"> | |
<tr><td> | |
<a name="Converting a project to GIT"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Converting a project to GIT</h1></a> | |
</td></tr> | |
<tr><td> | |
<blockquote class="sectionBody"> | |
<p>This describes the various steps needed in converting a project from SVN to GIT.</p> | |
<h3>File INFRA Jira ticket to convert read-only mirror to r/w</h3> | |
<p>Tell the dev list this is happening, so people should not make any changes until the conversion is done. | |
This may take 2-3 weeks, depending on INFRA workload.</p> | |
<p>Prior to doing the ticket, if you want the top level named "master" instead of "trunk", do that change | |
in SVN, and let it propogate to the read-only mirror (if one exists). This will save time after the | |
migration, because renames involve help from INFRA.</p> | |
<h3>File INFRA Jira tickets for additional setup or fixups</h3> | |
<p>If a rename is needed at this point for master/trunk, you'll need to ask INFRA to protect master | |
after the rename, and to set it as the default (removing trunk as the default). Once INFRA does this, | |
you can delete the old trunk.</p> | |
<h4>Renaming Branches</h4> | |
<p>In SVN, the main work goes into a spot under the name "trunk". The convention in git is to name this | |
the "master".</p> | |
<p>GIT renaming cannot be done directly by users if the branch is "protected"; | |
you must instead request it be done via an INFRA issue. This may take some time; see the kanban | |
board on the INFRA jira to get a sense of how many other requests are in front of yours.</p> | |
<blockquote>Therefore, it would be good to rename things yourself (e.g. in SVN).</blockquote> | |
<h3>Add .gitignore and .gitattributes</h3> | |
<p>These files should be added to the top (outer-most) containing folder for the projects in your repo. | |
They will be default apply to all subfolders. If you need to, you can override these settings in a subfolder.</p> | |
<p>Copy these files from some already converted repo.</p> | |
<h3>Dealing with protected branches</h3> | |
<p>The default, when converting a project from svn to git is to set "protection" for | |
the master branch and things called refs/heads/rel/ and refs/tags/rel/. | |
</p> | |
<p>The protection is described here: | |
<a target="_blank" rel="nofollow noopener" href="https://help.github.com/en/articles/about-protected-branches"> | |
https://help.github.com/en/articles/about-protected-branches</a>.</p> | |
<p>Individual projects within UIMA may request additional branch protection settings be set, via | |
INFRA Jira issues.</p> | |
<h3>Updating POMs for GIT</h3> | |
<p>POMs have an <scm> element that points to svn, and it should be updated as follows: | |
</p> | |
<ul> | |
<li>For the connection: | |
<p><code>scm:git:https://github.com/apache/...proj-name.../...subdir...</code></p> | |
</li> | |
<li>For the developerConnection: This must point to the entire repository (no subdirs) | |
<p><code>scm:git:https://github.com/apache/...proj-name.../</code></p> | |
</li> | |
<li>For the url: this should point to the source code at github, e.g. | |
<p><code>https://github.com/apache/...proj-name.../tree/master/...sub-proj-name...</code></p> | |
<p>For other versions, e.g. uima-v2, replace <code>master</code> with <code>master-v2</code> (or the other version name)</p></li> | |
</ul> | |
<h3>Update the website docs to refer to the source at github.com/apache.</h3> | |
</blockquote> | |
</p> | |
</td></tr> | |
</table> | |
</td> | |
</tr> | |
<!-- FOOTER --> | |
<tr><td colspan="2"> | |
<hr noshade="" size="1"/> | |
</td></tr> | |
<tr><td colspan="2"> | |
<table class="pageFooter"> | |
<tr> | |
<td><a href="index.html">Home</a></td> | |
<td><a href="privacy-policy.html">Privacy Policy</a></td> | |
<td style="font-size:75%"> | |
Copyright © 2006-2013, The Apache Software Foundation.<br/> | |
Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/> | |
All other marks mentioned may be trademarks or registered trademarks of their respective owners. | |
</td> | |
<td><a href="mailto:dev@uima.apache.org">Contact us</a></td> | |
</tr> | |
</table> | |
</td></tr> | |
</table> | |
</body> | |
</html> | |