| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" | |
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> | |
| <meta name="generator" content="AsciiDoc 8.6.10" /> | |
| <title>How to use a signed tag in pull requests</title> | |
| <style type="text/css"> | |
| /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ | |
| /* Default font. */ | |
| body { | |
| font-family: Georgia,serif; | |
| } | |
| /* Title font. */ | |
| h1, h2, h3, h4, h5, h6, | |
| div.title, caption.title, | |
| thead, p.table.header, | |
| #toctitle, | |
| #author, #revnumber, #revdate, #revremark, | |
| #footer { | |
| font-family: Arial,Helvetica,sans-serif; | |
| } | |
| body { | |
| margin: 1em 5% 1em 5%; | |
| } | |
| a { | |
| color: blue; | |
| text-decoration: underline; | |
| } | |
| a:visited { | |
| color: fuchsia; | |
| } | |
| em { | |
| font-style: italic; | |
| color: navy; | |
| } | |
| strong { | |
| font-weight: bold; | |
| color: #083194; | |
| } | |
| h1, h2, h3, h4, h5, h6 { | |
| color: #527bbd; | |
| margin-top: 1.2em; | |
| margin-bottom: 0.5em; | |
| line-height: 1.3; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: 2px solid silver; | |
| } | |
| h2 { | |
| padding-top: 0.5em; | |
| } | |
| h3 { | |
| float: left; | |
| } | |
| h3 + * { | |
| clear: left; | |
| } | |
| h5 { | |
| font-size: 1.0em; | |
| } | |
| div.sectionbody { | |
| margin-left: 0; | |
| } | |
| hr { | |
| border: 1px solid silver; | |
| } | |
| p { | |
| margin-top: 0.5em; | |
| margin-bottom: 0.5em; | |
| } | |
| ul, ol, li > p { | |
| margin-top: 0; | |
| } | |
| ul > li { color: #aaa; } | |
| ul > li > * { color: black; } | |
| .monospaced, code, pre { | |
| font-family: "Courier New", Courier, monospace; | |
| font-size: inherit; | |
| color: navy; | |
| padding: 0; | |
| margin: 0; | |
| } | |
| pre { | |
| white-space: pre-wrap; | |
| } | |
| #author { | |
| color: #527bbd; | |
| font-weight: bold; | |
| font-size: 1.1em; | |
| } | |
| #email { | |
| } | |
| #revnumber, #revdate, #revremark { | |
| } | |
| #footer { | |
| font-size: small; | |
| border-top: 2px solid silver; | |
| padding-top: 0.5em; | |
| margin-top: 4.0em; | |
| } | |
| #footer-text { | |
| float: left; | |
| padding-bottom: 0.5em; | |
| } | |
| #footer-badges { | |
| float: right; | |
| padding-bottom: 0.5em; | |
| } | |
| #preamble { | |
| margin-top: 1.5em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.imageblock, div.exampleblock, div.verseblock, | |
| div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
| div.admonitionblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.admonitionblock { | |
| margin-top: 2.0em; | |
| margin-bottom: 2.0em; | |
| margin-right: 10%; | |
| color: #606060; | |
| } | |
| div.content { /* Block element content. */ | |
| padding: 0; | |
| } | |
| /* Block element titles. */ | |
| div.title, caption.title { | |
| color: #527bbd; | |
| font-weight: bold; | |
| text-align: left; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.5em; | |
| } | |
| div.title + * { | |
| margin-top: 0; | |
| } | |
| td div.title:first-child { | |
| margin-top: 0.0em; | |
| } | |
| div.content div.title:first-child { | |
| margin-top: 0.0em; | |
| } | |
| div.content + div.title { | |
| margin-top: 0.0em; | |
| } | |
| div.sidebarblock > div.content { | |
| background: #ffffee; | |
| border: 1px solid #dddddd; | |
| border-left: 4px solid #f0f0f0; | |
| padding: 0.5em; | |
| } | |
| div.listingblock > div.content { | |
| border: 1px solid #dddddd; | |
| border-left: 5px solid #f0f0f0; | |
| background: #f8f8f8; | |
| padding: 0.5em; | |
| } | |
| div.quoteblock, div.verseblock { | |
| padding-left: 1.0em; | |
| margin-left: 1.0em; | |
| margin-right: 10%; | |
| border-left: 5px solid #f0f0f0; | |
| color: #888; | |
| } | |
| div.quoteblock > div.attribution { | |
| padding-top: 0.5em; | |
| text-align: right; | |
| } | |
| div.verseblock > pre.content { | |
| font-family: inherit; | |
| font-size: inherit; | |
| } | |
| div.verseblock > div.attribution { | |
| padding-top: 0.75em; | |
| text-align: left; | |
| } | |
| /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
| div.verseblock + div.attribution { | |
| text-align: left; | |
| } | |
| div.admonitionblock .icon { | |
| vertical-align: top; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| text-decoration: underline; | |
| color: #527bbd; | |
| padding-right: 0.5em; | |
| } | |
| div.admonitionblock td.content { | |
| padding-left: 0.5em; | |
| border-left: 3px solid #dddddd; | |
| } | |
| div.exampleblock > div.content { | |
| border-left: 3px solid #dddddd; | |
| padding-left: 0.5em; | |
| } | |
| div.imageblock div.content { padding-left: 0; } | |
| span.image img { border-style: none; vertical-align: text-bottom; } | |
| a.image:visited { color: white; } | |
| dl { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| dt { | |
| margin-top: 0.5em; | |
| margin-bottom: 0; | |
| font-style: normal; | |
| color: navy; | |
| } | |
| dd > *:first-child { | |
| margin-top: 0.1em; | |
| } | |
| ul, ol { | |
| list-style-position: outside; | |
| } | |
| ol.arabic { | |
| list-style-type: decimal; | |
| } | |
| ol.loweralpha { | |
| list-style-type: lower-alpha; | |
| } | |
| ol.upperalpha { | |
| list-style-type: upper-alpha; | |
| } | |
| ol.lowerroman { | |
| list-style-type: lower-roman; | |
| } | |
| ol.upperroman { | |
| list-style-type: upper-roman; | |
| } | |
| div.compact ul, div.compact ol, | |
| div.compact p, div.compact p, | |
| div.compact div, div.compact div { | |
| margin-top: 0.1em; | |
| margin-bottom: 0.1em; | |
| } | |
| tfoot { | |
| font-weight: bold; | |
| } | |
| td > div.verse { | |
| white-space: pre; | |
| } | |
| div.hdlist { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| div.hdlist tr { | |
| padding-bottom: 15px; | |
| } | |
| dt.hdlist1.strong, td.hdlist1.strong { | |
| font-weight: bold; | |
| } | |
| td.hdlist1 { | |
| vertical-align: top; | |
| font-style: normal; | |
| padding-right: 0.8em; | |
| color: navy; | |
| } | |
| td.hdlist2 { | |
| vertical-align: top; | |
| } | |
| div.hdlist.compact tr { | |
| margin: 0; | |
| padding-bottom: 0; | |
| } | |
| .comment { | |
| background: yellow; | |
| } | |
| .footnote, .footnoteref { | |
| font-size: 0.8em; | |
| } | |
| span.footnote, span.footnoteref { | |
| vertical-align: super; | |
| } | |
| #footnotes { | |
| margin: 20px 0 20px 0; | |
| padding: 7px 0 0 0; | |
| } | |
| #footnotes div.footnote { | |
| margin: 0 0 5px 0; | |
| } | |
| #footnotes hr { | |
| border: none; | |
| border-top: 1px solid silver; | |
| height: 1px; | |
| text-align: left; | |
| margin-left: 0; | |
| width: 20%; | |
| min-width: 100px; | |
| } | |
| div.colist td { | |
| padding-right: 0.5em; | |
| padding-bottom: 0.3em; | |
| vertical-align: top; | |
| } | |
| div.colist td img { | |
| margin-top: 0.3em; | |
| } | |
| @media print { | |
| #footer-badges { display: none; } | |
| } | |
| #toc { | |
| margin-bottom: 2.5em; | |
| } | |
| #toctitle { | |
| color: #527bbd; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.1em; | |
| } | |
| div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
| margin-top: 0; | |
| margin-bottom: 0; | |
| } | |
| div.toclevel2 { | |
| margin-left: 2em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel3 { | |
| margin-left: 4em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel4 { | |
| margin-left: 6em; | |
| font-size: 0.9em; | |
| } | |
| span.aqua { color: aqua; } | |
| span.black { color: black; } | |
| span.blue { color: blue; } | |
| span.fuchsia { color: fuchsia; } | |
| span.gray { color: gray; } | |
| span.green { color: green; } | |
| span.lime { color: lime; } | |
| span.maroon { color: maroon; } | |
| span.navy { color: navy; } | |
| span.olive { color: olive; } | |
| span.purple { color: purple; } | |
| span.red { color: red; } | |
| span.silver { color: silver; } | |
| span.teal { color: teal; } | |
| span.white { color: white; } | |
| span.yellow { color: yellow; } | |
| span.aqua-background { background: aqua; } | |
| span.black-background { background: black; } | |
| span.blue-background { background: blue; } | |
| span.fuchsia-background { background: fuchsia; } | |
| span.gray-background { background: gray; } | |
| span.green-background { background: green; } | |
| span.lime-background { background: lime; } | |
| span.maroon-background { background: maroon; } | |
| span.navy-background { background: navy; } | |
| span.olive-background { background: olive; } | |
| span.purple-background { background: purple; } | |
| span.red-background { background: red; } | |
| span.silver-background { background: silver; } | |
| span.teal-background { background: teal; } | |
| span.white-background { background: white; } | |
| span.yellow-background { background: yellow; } | |
| span.big { font-size: 2em; } | |
| span.small { font-size: 0.6em; } | |
| span.underline { text-decoration: underline; } | |
| span.overline { text-decoration: overline; } | |
| span.line-through { text-decoration: line-through; } | |
| div.unbreakable { page-break-inside: avoid; } | |
| /* | |
| * xhtml11 specific | |
| * | |
| * */ | |
| div.tableblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.tableblock > table { | |
| border: 3px solid #527bbd; | |
| } | |
| thead, p.table.header { | |
| font-weight: bold; | |
| color: #527bbd; | |
| } | |
| p.table { | |
| margin-top: 0; | |
| } | |
| /* Because the table frame attribute is overriden by CSS in most browsers. */ | |
| div.tableblock > table[frame="void"] { | |
| border-style: none; | |
| } | |
| div.tableblock > table[frame="hsides"] { | |
| border-left-style: none; | |
| border-right-style: none; | |
| } | |
| div.tableblock > table[frame="vsides"] { | |
| border-top-style: none; | |
| border-bottom-style: none; | |
| } | |
| /* | |
| * html5 specific | |
| * | |
| * */ | |
| table.tableblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| thead, p.tableblock.header { | |
| font-weight: bold; | |
| color: #527bbd; | |
| } | |
| p.tableblock { | |
| margin-top: 0; | |
| } | |
| table.tableblock { | |
| border-width: 3px; | |
| border-spacing: 0px; | |
| border-style: solid; | |
| border-color: #527bbd; | |
| border-collapse: collapse; | |
| } | |
| th.tableblock, td.tableblock { | |
| border-width: 1px; | |
| padding: 4px; | |
| border-style: solid; | |
| border-color: #527bbd; | |
| } | |
| table.tableblock.frame-topbot { | |
| border-left-style: hidden; | |
| border-right-style: hidden; | |
| } | |
| table.tableblock.frame-sides { | |
| border-top-style: hidden; | |
| border-bottom-style: hidden; | |
| } | |
| table.tableblock.frame-none { | |
| border-style: hidden; | |
| } | |
| th.tableblock.halign-left, td.tableblock.halign-left { | |
| text-align: left; | |
| } | |
| th.tableblock.halign-center, td.tableblock.halign-center { | |
| text-align: center; | |
| } | |
| th.tableblock.halign-right, td.tableblock.halign-right { | |
| text-align: right; | |
| } | |
| th.tableblock.valign-top, td.tableblock.valign-top { | |
| vertical-align: top; | |
| } | |
| th.tableblock.valign-middle, td.tableblock.valign-middle { | |
| vertical-align: middle; | |
| } | |
| th.tableblock.valign-bottom, td.tableblock.valign-bottom { | |
| vertical-align: bottom; | |
| } | |
| /* | |
| * manpage specific | |
| * | |
| * */ | |
| body.manpage h1 { | |
| padding-top: 0.5em; | |
| padding-bottom: 0.5em; | |
| border-top: 2px solid silver; | |
| border-bottom: 2px solid silver; | |
| } | |
| body.manpage h2 { | |
| border-style: none; | |
| } | |
| body.manpage div.sectionbody { | |
| margin-left: 3em; | |
| } | |
| @media print { | |
| body.manpage div#toc { display: none; } | |
| } | |
| </style> | |
| <script type="text/javascript"> | |
| /*<+'])'); | |
| // Function that scans the DOM tree for header elements (the DOM2 | |
| // nodeIterator API would be a better technique but not supported by all | |
| // browsers). | |
| var iterate = function (el) { | |
| for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
| if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { | |
| var mo = re.exec(i.tagName); | |
| if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { | |
| result[result.length] = new TocEntry(i, getText(i), mo[1]-1); | |
| } | |
| iterate(i); | |
| } | |
| } | |
| } | |
| iterate(el); | |
| return result; | |
| } | |
| var toc = document.getElementById("toc"); | |
| if (!toc) { | |
| return; | |
| } | |
| // Delete existing TOC entries in case we're reloading the TOC. | |
| var tocEntriesToRemove = []; | |
| var i; | |
| for (i = 0; i < toc.childNodes.length; i++) { | |
| var entry = toc.childNodes[i]; | |
| if (entry.nodeName.toLowerCase() == 'div' | |
| && entry.getAttribute("class") | |
| && entry.getAttribute("class").match(/^toclevel/)) | |
| tocEntriesToRemove.push(entry); | |
| } | |
| for (i = 0; i < tocEntriesToRemove.length; i++) { | |
| toc.removeChild(tocEntriesToRemove[i]); | |
| } | |
| // Rebuild TOC entries. | |
| var entries = tocEntries(document.getElementById("content"), toclevels); | |
| for (var i = 0; i < entries.length; ++i) { | |
| var entry = entries[i]; | |
| if (entry.element.id == "") | |
| entry.element.id = "_toc_" + i; | |
| var a = document.createElement("a"); | |
| a.href = "#" + entry.element.id; | |
| a.appendChild(document.createTextNode(entry.text)); | |
| var div = document.createElement("div"); | |
| div.appendChild(a); | |
| div.className = "toclevel" + entry.toclevel; | |
| toc.appendChild(div); | |
| } | |
| if (entries.length == 0) | |
| toc.parentNode.removeChild(toc); | |
| }, | |
| ///////////////////////////////////////////////////////////////////// | |
| // Footnotes generator | |
| ///////////////////////////////////////////////////////////////////// | |
| /* Based on footnote generation code from: | |
| * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html | |
| */ | |
| footnotes: function () { | |
| // Delete existing footnote entries in case we're reloading the footnodes. | |
| var i; | |
| var noteholder = document.getElementById("footnotes"); | |
| if (!noteholder) { | |
| return; | |
| } | |
| var entriesToRemove = []; | |
| for (i = 0; i < noteholder.childNodes.length; i++) { | |
| var entry = noteholder.childNodes[i]; | |
| if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") | |
| entriesToRemove.push(entry); | |
| } | |
| for (i = 0; i < entriesToRemove.length; i++) { | |
| noteholder.removeChild(entriesToRemove[i]); | |
| } | |
| // Rebuild footnote entries. | |
| var cont = document.getElementById("content"); | |
| var spans = cont.getElementsByTagName("span"); | |
| var refs = {}; | |
| var n = 0; | |
| for (i=0; i<spans.length; i++) { | |
| if (spans[i].className == "footnote") { | |
| n++; | |
| var note = spans[i].getAttribute("data-note"); | |
| if (!note) { | |
| // Use [\s\S] in place of . so multi-line matches work. | |
| // Because JavaScript has no s (dotall) regex flag. | |
| note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; | |
| spans[i].innerHTML = | |
| "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + | |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
| spans[i].setAttribute("data-note", note); | |
| } | |
| noteholder.innerHTML += | |
| "<div class='footnote' id='_footnote_" + n + "'>" + | |
| "<a href='#_footnoteref_" + n + "' title='Return to text'>" + | |
| n + "</a>. " + note + "</div>"; | |
| var id =spans[i].getAttribute("id"); | |
| if (id != null) refs["#"+id] = n; | |
| } | |
| } | |
| if (n == 0) | |
| noteholder.parentNode.removeChild(noteholder); | |
| else { | |
| // Process footnoterefs. | |
| for (i=0; i<spans.length; i++) { | |
| if (spans[i].className == "footnoteref") { | |
| var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); | |
| href = href.match(/#.*/)[0]; // Because IE return full URL. | |
| n = refs[href]; | |
| spans[i].innerHTML = | |
| "[<a href='#_footnote_" + n + | |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
| } | |
| } | |
| } | |
| }, | |
| install: function(toclevels) { | |
| var timerId; | |
| function reinstall() { | |
| asciidoc.footnotes(); | |
| if (toclevels) { | |
| asciidoc.toc(toclevels); | |
| } | |
| } | |
| function reinstallAndRemoveTimer() { | |
| clearInterval(timerId); | |
| reinstall(); | |
| } | |
| timerId = setInterval(reinstall, 500); | |
| if (document.addEventListener) | |
| document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); | |
| else | |
| window.onload = reinstallAndRemoveTimer; | |
| } | |
| } | |
| asciidoc.install(); | |
| /*]]>*/ | |
| </script> | |
| </head> | |
| <body class="article"> | |
| <div id="header"> | |
| <h1>How to use a signed tag in pull requests</h1> | |
| </div> | |
| <div id="content"> | |
| <div id="preamble"> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>A typical distributed workflow using Git is for a contributor to fork a | |
| project, build on it, publish the result to her public repository, and ask | |
| the "upstream" person (often the owner of the project where she forked | |
| from) to pull from her public repository. Requesting such a "pull" is made | |
| easy by the <code>git request-pull</code> command.</p></div> | |
| <div class="paragraph"><p>Earlier, a typical pull request may have started like this:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> The following changes since commit 406da78032179...: | |
| Froboz 3.2 (2011-09-30 14:20:57 -0700) | |
| are available in the Git repository at: | |
| example.com:/git/froboz.git for-xyzzy</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>followed by a shortlog of the changes and a diffstat.</p></div> | |
| <div class="paragraph"><p>The request was for a branch name (e.g. <code>for-xyzzy</code>) in the public | |
| repository of the contributor, and even though it stated where the | |
| contributor forked her work from, the message did not say anything about | |
| the commit to expect at the tip of the for-xyzzy branch. If the site that | |
| hosts the public repository of the contributor cannot be fully trusted, it | |
| was unnecessarily hard to make sure what was pulled by the integrator was | |
| genuinely what the contributor had produced for the project. Also there | |
| was no easy way for third-party auditors to later verify the resulting | |
| history.</p></div> | |
| <div class="paragraph"><p>Starting from Git release v1.7.9, a contributor can add a signed tag to | |
| the commit at the tip of the history and ask the integrator to pull that | |
| signed tag. When the integrator runs <code>git pull</code>, the signed tag is | |
| automatically verified to assure that the history is not tampered with. | |
| In addition, the resulting merge commit records the content of the signed | |
| tag, so that other people can verify that the branch merged by the | |
| integrator was signed by the contributor, without fetching the signed tag | |
| used to validate the pull request separately and keeping it in the refs | |
| namespace.</p></div> | |
| <div class="paragraph"><p>This document describes the workflow between the contributor and the | |
| integrator, using Git v1.7.9 or later.</p></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_a_contributor_or_a_lieutenant">A contributor or a lieutenant</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>After preparing her work to be pulled, the contributor uses <code>git tag -s</code> | |
| to create a signed tag:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> $ git checkout work | |
| $ ... "git pull" from sublieutenants, "git commit" your own work ... | |
| $ git tag -s -m "Completed frotz feature" frotz-for-xyzzy work</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>Note that this example uses the <code>-m</code> option to create a signed tag with | |
| just a one-liner message, but this is for illustration purposes only. It | |
| is advisable to compose a well-written explanation of what the topic does | |
| to justify why it is worthwhile for the integrator to pull it, as this | |
| message will eventually become part of the final history after the | |
| integrator responds to the pull request (as we will see later).</p></div> | |
| <div class="paragraph"><p>Then she pushes the tag out to her public repository:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> $ git push example.com:/git/froboz.git/ +frotz-for-xyzzy</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>There is no need to push the <code>work</code> branch or anything else.</p></div> | |
| <div class="paragraph"><p>Note that the above command line used a plus sign at the beginning of | |
| <code>+frotz-for-xyzzy</code> to allow forcing the update of a tag, as the same | |
| contributor may want to reuse a signed tag with the same name after the | |
| previous pull request has already been responded to.</p></div> | |
| <div class="paragraph"><p>The contributor then prepares a message to request a "pull":</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> $ git request-pull v3.2 example.com:/git/froboz.git/ frotz-for-xyzzy >msg.txt</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>The arguments are:</p></div> | |
| <div class="olist arabic"><ol class="arabic"> | |
| <li> | |
| <p> | |
| the version of the integrator’s commit the contributor based her work on; | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| the URL of the repository, to which the contributor has pushed what she | |
| wants to get pulled; and | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| the name of the tag the contributor wants to get pulled (earlier, she could | |
| write only a branch name here). | |
| </p> | |
| </li> | |
| </ol></div> | |
| <div class="paragraph"><p>The resulting msg.txt file begins like so:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> The following changes since commit 406da78032179...: | |
| Froboz 3.2 (2011-09-30 14:20:57 -0700) | |
| are available in the Git repository at: | |
| example.com:/git/froboz.git tags/frotz-for-xyzzy | |
| for you to fetch changes up to 703f05ad5835c...: | |
| Add tests and documentation for frotz (2011-12-02 10:02:52 -0800) | |
| ----------------------------------------------- | |
| Completed frotz feature | |
| -----------------------------------------------</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>followed by a shortlog of the changes and a diffstat. Comparing this with | |
| the earlier illustration of the output from the traditional <code>git request-pull</code> | |
| command, the reader should notice that:</p></div> | |
| <div class="olist arabic"><ol class="arabic"> | |
| <li> | |
| <p> | |
| The tip commit to expect is shown to the integrator; and | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| The signed tag message is shown prominently between the dashed lines | |
| before the shortlog. | |
| </p> | |
| </li> | |
| </ol></div> | |
| <div class="paragraph"><p>The latter is why the contributor would want to justify why pulling her | |
| work is worthwhile when creating the signed tag. The contributor then | |
| opens her favorite MUA, reads msg.txt, edits and sends it to her upstream | |
| integrator.</p></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_integrator">Integrator</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>After receiving such a pull request message, the integrator fetches and | |
| integrates the tag named in the request, with:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> $ git pull example.com:/git/froboz.git/ tags/frotz-for-xyzzy</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>This operation will always open an editor to allow the integrator to fine | |
| tune the commit log message when merging a signed tag. Also, pulling a | |
| signed tag will always create a merge commit even when the integrator does | |
| not have any new commit since the contributor’s work forked (i.e. <em>fast | |
| forward</em>), so that the integrator can properly explain what the merge is | |
| about and why it was made.</p></div> | |
| <div class="paragraph"><p>In the editor, the integrator will see something like this:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> Merge tag 'frotz-for-xyzzy' of example.com:/git/froboz.git/ | |
| Completed frotz feature | |
| # gpg: Signature made Fri 02 Dec 2011 10:03:01 AM PST using RSA key ID 96AFE6CB | |
| # gpg: Good signature from "Con Tributor <nitfol@example.com>"</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>Notice that the message recorded in the signed tag "Completed frotz | |
| feature" appears here, and again that is why it is important for the | |
| contributor to explain her work well when creating the signed tag.</p></div> | |
| <div class="paragraph"><p>As usual, the lines commented with <code>#</code> are stripped out. The resulting | |
| commit records the signed tag used for this validation in a hidden field | |
| so that it can later be used by others to audit the history. There is no | |
| need for the integrator to keep a separate copy of the tag in his | |
| repository (i.e. <code>git tag -l</code> won’t list the <code>frotz-for-xyzzy</code> tag in the | |
| above example), and there is no need to publish the tag to his public | |
| repository, either.</p></div> | |
| <div class="paragraph"><p>After the integrator responds to the pull request and her work becomes | |
| part of the permanent history, the contributor can remove the tag from | |
| her public repository, if she chooses, in order to keep the tag namespace | |
| of her public repository clean, with:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> $ git push example.com:/git/froboz.git :frotz-for-xyzzy</code></pre> | |
| </div></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_auditors">Auditors</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>The <code>--show-signature</code> option can be given to <code>git log</code> or <code>git show</code> and | |
| shows the verification status of the embedded signed tag in merge commits | |
| created when the integrator responded to a pull request of a signed tag.</p></div> | |
| <div class="paragraph"><p>A typical output from <code>git show --show-signature</code> may look like this:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> $ git show --show-signature | |
| commit 02306ef6a3498a39118aef9df7975bdb50091585 | |
| merged tag 'frotz-for-xyzzy' | |
| gpg: Signature made Fri 06 Jan 2012 12:41:49 PM PST using RSA key ID 96AFE6CB | |
| gpg: Good signature from "Con Tributor <nitfol@example.com>" | |
| Merge: 406da78 703f05a | |
| Author: Inte Grator <xyzzy@example.com> | |
| Date: Tue Jan 17 13:49:41 2012 -0800 | |
| Merge tag 'frotz-for-xyzzy' of example.com:/git/froboz.git/ | |
| Completed frotz feature | |
| * tag 'frotz-for-xyzzy' (100 commits) | |
| Add tests and documentation for frotz | |
| ...</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>There is no need for the auditor to explicitly fetch the contributor’s | |
| signature, or to even be aware of what tag(s) the contributor and integrator | |
| used to communicate the signature. All the required information is recorded | |
| as part of the merge commit.</p></div> | |
| </div> | |
| </div> | |
| </div> | |
| <div id="footnotes"><hr /></div> | |
| <div id="footer"> | |
| <div id="footer-text"> | |
| Last updated | |
| 2018-11-21 22:44:10 JST | |
| </div> | |
| </div> | |
| </body> | |
| </html> |