Building Help as Part of the Software Build Process

[hknix]

All -

I'm thinking there has to be someone out there that has this implemented. Currently, I have to check my compiled online Help (from Flare 10.x into HTML5 Help) into TFS so it will get picked up with the nightly software build and deployed to the environments where our QA people and others test. This is an old school implementation from someone who was at my job before me and was very resistant to change.

I want to change this process so the compile of the HTML5 help happens with our software builds, so I don't have to check compiled content into a source control system (which seems redundant since the source files get checked in as well). It's my understanding that I can build the Help target using the command line, with a command pointed to an installation of Flare. I have one license of Flare... mine. Is a second license required for the command line to run successfully on the build machine? The engineers that are responsible for our software build process tell me that they can run from the command line... just need to know what sort of licenses are required to make that happen.

Thank you for any information on how to successfully implement such a set up.

[NorthEast]

Yes, we've done this in the past, i.e. our build process ran the command line to build the help.
We use a more manual method now - we build and publish to a particular destination, and the build takes the files from that location.

Regarding the licence, I'd suggest checking this with MadCap (I would guess you need two licences).

[RamonS]

Just recently I got to discuss this topic and including help builds in the build process is not necessarily always the best approach. In my case it was about a web app that is only available as hosted solution (SaaS) and all instances will always be at the exact same release version (although it wouldn't matter if it is different). What was done before is packaging help with the app and deploying through build and publish, but that means that every instance has its own copy of static help files. The more instances get deployed the more times the exact same help files get copied out. In this case it seemed better to decouple help deployment from software builds and instead have all instances retrieve the help from the same location. That will also make help updates easier because that no longer requires pushing out the entire application and thus limits downtime and does not require advance notification. Yes, it could be that depending on the copy process for the help system one or more users might not be able to access the help, but that chance is rather slim and way smaller than te chance to get the same result due to volatile network connections.

[kwag_myers]

We're in the process of making this switch and I can't say that I'm totally sold on the idea. The name "Rube Goldberg" keeps coming to mind. However, I've been told that this is the new way. I think the phrase was, "In today's world..." in response to my concerns. It's suppose to make my job easier, which I don't get because I still have to build locally to check my work.

We're using Perforce source control, and when I did a search in these forums all I found were threads from people struggling with the integration. With the exception of SourceSafe, I've never gotten along with source control. Perforce has been a particular issue for me. Apparently, when it comes to integration, I'm not alone.

Anyway, you may want to do a search on the source control you're using to find more information.

[ChoccieMuffin]

We get our build to work automatically, though the build machine has to have its own licence. I have a sneaky suspicion that MadCap understand the need for a licence for a build machine and have a specific version but I could be mistaken. Give them a ring or drop them a line.

Our build script runs Flare to run the batch target editor in each project, which can include several targets in the one project. Works very well.

[kwag_myers]

They do have a build license, and a trial period as well.

[hknix]

Thank you all for your responses. I contacted MadCap today about a build license... they are pricey, but they have them. It's good to know that people have had success with the implementation.

[RamonS]

I knew that MadCap has build licenses, it is Flare with the UI turned off and thus discounted in price, but apparently not enough. One more reason NOT to include help builds in the automated build process if that is possible. Build it as a separate project to its own destination that is accessed by all instances of the application....unless it is a self-hosted or desktop app without Internet access available.
You could also see if you could use an existing Flare license. IIRC you can use the same license to install and register Flare on two systems, but not use it at the same time. As long as the license is 'free' when the build runs you could put an existing license to dual use. That said, ask MadCap if that is considered allowed usage.

[Tyler]

You can install Flare on two systems as long as they are on different domains. Madcap's response to my question about it: "That secondary activation is only for personal home use on a computer outside of the same domain as the primary, and the primary and secondary users must be the same person."