Bug 703688

Summary: Add Builder version ID to interface and output
Product: [Community] PressGang CCMS Reporter: Joshua Wulf <jwulf>
Component: Web-UIAssignee: Joshua Wulf <jwulf>
Status: CLOSED DUPLICATE QA Contact:
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 1.xCC: lcarlon, mcaspers, topic-tool-list
Target Milestone: ---Keywords: Reopened
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-05-20 02:43:34 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Bug Depends On: 703849    
Bug Blocks:    

Description Joshua Wulf 2011-05-11 02:19:44 UTC
1. Can we add a Skynet builder ID to the Author Group, so that it's easier to track whether a build was made using the latest version of the builder code?

2. Also, can we add a <remark>Builder version:</remark> to each topic and nav page, so that we can build with remarks on to get that as debugging information.

3. Can we put the current builder version in the Skynet interface.

I want to avoid logging bugs based on outdated output. This makes it easy to identify the version that produced the output, and the current version.

Comment 1 Matthew Casperson 2011-05-11 06:14:53 UTC
Done. Build version is added to bugzilla link.

Comment 2 Joshua Wulf 2011-05-11 11:54:22 UTC
And when you fix something related to the builder, set the status of the bug to ON_QA, and put a note in the bug saying: "Fixed in builder version XXXX"

Comment 3 Joshua Wulf 2011-05-11 21:39:02 UTC
Can you format it like this:

<para class="debug"><remark>Built with Skynet version XXXX</remark></para>

This will allow us to do two things:
1. Optionally include or exclude it in builds by turning remarks on or off
2. Style it in css so that it shows up as a lighter shade of gray

Comment 4 Matthew Casperson 2011-05-11 23:03:53 UTC
Fixed in 20110512-0903

Comment 6 Matthew Casperson 2011-05-12 21:54:31 UTC
Fixed in 20110513-0753

Comment 7 Joshua Wulf 2011-05-13 11:58:54 UTC
Looking good. 

A couple of things:

1. In Skynet 20110513-0753 the link is being inserted above the Bugzilla link. It should be inserted beneath the Bugzilla link. It is, in essence, a footnote.

ref: http://jboss-eap.bne.redhat.com/EAP6/wireframe/130511/PlaceholderXRef2608.html

2. For some reason it doesn't seem to be output on pages where there is an existing xml topic.
ref: http://jboss-eap.bne.redhat.com/EAP6/wireframe/130511/Tasks_Middleware_AS_Install_JBoss_AS.html

On pages such as the one referenced in point 1 above, where there is no existing topic xml, the Skynet builder link is output.

Comment 8 Matthew Casperson 2011-05-16 02:53:34 UTC
Fixed in 20110516-1246

Comment 9 Joshua Wulf 2011-05-18 01:49:40 UTC
Still not working everywhere.

Ref: http://jboss-eap.bne.redhat.com/wireframes/EAP6/110518/PlaceholderXRef700.html

Comment 10 Matthew Casperson 2011-05-18 03:15:02 UTC
Fixed in 20110518-1257

Comment 12 Joshua Wulf 2011-05-18 05:35:05 UTC
Hang on, let me rebuild that with show_remarks: 1

Comment 13 Joshua Wulf 2011-05-18 06:07:51 UTC
It shows up when there is no topic text.

In cases where topic text exists, the SKynet Builder is putting it into a <section>, which isn't showing up:

Works: http://jboss-eap.bne.redhat.com/wireframes/EAP6/110518/ch03.html#PlaceholderXRef1649

Docbook source:

<title>Task</title>
<section id="PlaceholderXRef1649" role="IAProposed">
	<title>Use the JTS API</title>
	<note>
		<title>NOTE - TOPIC NOT WRITTEN - TOPIC ID: 2195 </title>
		<para>This topic has not yet been written. The content below is from the topic description.</para>
	</note>
   <para>
		New Topic
   </para>
	<para>
		<ulink url="https://bugzilla.redhat.com/enter_bug.cgi?product=Topic+Tool&amp;component=web-Topic_Index&amp;comment=Leave%20this%20line%20in%20the%20report.%20Topic%20ID:2195%20Build:%2020110518-1323">Report a bug: 2195</ulink>
	</para>
	<para>
		<ulink url="http://jboss-eap.bne.redhat.com:8080/TopicIndex/CustomSearchTopicList.seam?topicId=2195">View in Skynet</ulink>
	</para>
	<remark>
		<ulink url="http://jboss-eap.bne.redhat.com:8080/TopicIndex/CustomSearchTopics.seam?tag13=1">Built with Skynet version 20110518-1323</ulink>
	</remark>
</section>

Does not work:
http://jboss-eap.bne.redhat.com/wireframes/EAP6/110518/Tasks_Middleware_AS_Build_AS_from_Source.html

Docbook source:

<section><title/><formalpara><title>Navigation</title><para><itemizedlist><listitem><para><xref linkend="PrimaryNavPage-1-1-2-60"/></para></listitem><listitem><para><xref linkend="PrimaryNavPage-1-1-2-85"/></para></listitem><listitem><para><xref linkend="PrimaryNavPage-1-1-3-69"/></para></listitem><listitem><para><xref linkend="PrimaryNavPage-1-2-2-60"/></para></listitem><listitem><para><xref linkend="PrimaryNavPage-1-2-2-85"/></para></listitem><listitem><para><xref linkend="PrimaryNavPage-1-2-3-69"/></para></listitem></itemizedlist></para></formalpara></section><section><title/><para role="RoleCreateBugPara"><ulink url="https://bugzilla.redhat.com/enter_bug.cgi?product=Topic+Tool&amp;component=web-Topic_Index&amp;comment=Leave%20this%20line%20in%20the%20report.%20Topic%20ID:45%20Build:%2020110518-1323">Report a bug: 45</ulink></para><para role="RoleViewInSkyNetPara"><ulink url="http://jboss-eap.bne.redhat.com:8080/TopicIndex/CustomSearchTopicList.seam?topicId=45">View in Skynet</ulink></para><remark role="RoleBuildVersionPara"><ulink url="http://jboss-eap.bne.redhat.com:8080/TopicIndex/CustomSearchTopics.seam?tag13=1">Built with Skynet version 20110518-1323</ulink></remark></section></section>

The Navigation shows up in the build, but the "Report a Bug" and "Built with Skynet Version" do not.

Too many "hanging sections"?

Comment 14 Matthew Casperson 2011-05-18 22:12:44 UTC
This is an issue with splitting on section. html-single version shows the "Report a Bug" and "Built with Skynet Version" links.

Comment 15 Matthew Casperson 2011-05-18 22:13:54 UTC
These post processing links and remarks need to be included in sections due to the way overviews are built. The fix is to either change how overviews are constructed, or work out some different way to chunk in publican.

Comment 16 Joshua Wulf 2011-05-20 02:43:34 UTC
Now a duplicate of https://bugzilla.redhat.com/show_bug.cgi?id=705711

*** This bug has been marked as a duplicate of bug 705711 ***