From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 180DE21D147D7 for ; Tue, 11 Jul 2017 10:03:30 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 8CE3D80C1D; Tue, 11 Jul 2017 17:05:15 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 8CE3D80C1D Authentication-Results: ext-mx02.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx02.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=lersek@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 8CE3D80C1D Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-201.phx2.redhat.com [10.3.116.201]) by smtp.corp.redhat.com (Postfix) with ESMTP id E94CF5D6A3; Tue, 11 Jul 2017 17:05:14 +0000 (UTC) To: "Kinney, Michael D" Cc: "edk2-devel@lists.01.org" References: <641e085b-2797-cc7f-fd0b-97a685c7725c@redhat.com> From: Laszlo Ersek Message-ID: <48511335-6c66-b536-8685-4f14bbc010e8@redhat.com> Date: Tue, 11 Jul 2017 19:05:13 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.2.1 MIME-Version: 1.0 In-Reply-To: X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.26]); Tue, 11 Jul 2017 17:05:15 +0000 (UTC) Subject: Re: TianoCore-docs GitBook Documentation Process X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 11 Jul 2017 17:03:30 -0000 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit On 07/11/17 17:21, Kinney, Michael D wrote: > Laszlo, > > I found a GitBook plugin that can provide the branch name and > the SHA hash in either short or long form. > > https://plugins.gitbook.com/plugin/gitversion > > Here is an example patch to the EDK II Template Specification > That add this plugin to book.json and add the branch name and > SHA hash below the build time/date stamp of the document. > > diff --git a/README.md b/README.md > index 30edb2a..4ad8a96 100644 > --- a/README.md > +++ b/README.md > @@ -41,6 +41,10 @@ > > ** {{ gitbook.time|date('MM/DD/YYYY hh:mm:ss') }} ** > > +** {{ "GIT branch: " | gitBranch }} ** > + > +** {{ "GIT hash: " | gitLong }} ** > + > {% if book.udkrelease %} > ** {{ book.udkrelease }} ** > {% endif %} > diff --git a/book.json b/book.json > index 8c58ffe..d94cbcc 100644 > --- a/book.json > +++ b/book.json > @@ -5,6 +5,6 @@ > "version" : "Revision 0.20" > }, > > - "plugins": ["puml"], > + "plugins": ["puml", "gitversion"], > "pluginsConfig": {} > } Ah, great! Does the fact that the plugin list is provided in the book itself (in "book.json") imply that gitbook.com too will load the plugin, and generate the right output, in these "remote" renderings? Thank you, Laszlo