Skip to main content
Inspiring
April 3, 2023
Question

RH 2019 Classic - What files need to be tracked in (external) source control system?

  • April 3, 2023
  • 4 replies
  • 410 views

As hard as I try to figure this out via this forum, the internet at large, experimentation, or flat out guessing, I can't seem to nail down what files actually need to be saved in a source control system (eg GIT) and what doesn't.

Can anyone point to an official and definitive source for this information?

Many thanks.

    This topic has been closed for replies.

    4 replies

    davidk99046111
    Inspiring
    April 4, 2023

    If others are pushing and pulling, make sure you communicate any changes being pushed regarding the constantly changing variable files and output templates (like output pathways, output file names etc).  We usually discard those files in our branches to avoid a collision.  

    Peter Grainge
    Community Expert
    Community Expert
    April 4, 2023

    Essentially you put the whole project in source control with the exception of the files mentioned on my site. The idea is you can later pull out a complete version of your project.

     

    The exceptions stated are ones that are unique to each user and/or that RoboHelp will build.

     

    The SSL content is different. Many argue that it can be rebuilt by pulling the source files so why add to the volume stored. A possible snag is that way down the line, changes in RoboHelp may mean that the output may not be 100% the same. For example, a skin may have changed in some way, whether or not that matters will depend on the scenario.

     

    A worse scenario would be if the project was created in a Classic version of RoboHelp and years later the output had to be recreated. At that point only the new UI might be available and the output was with a webhelp skin. Webhelp skins change to responsive skins in the new UI so the old output could not be recreated. The content would be there but not the appearance. This is perhaps an unlikely scenario but that's for you to decide. 

    ________________________________________________________

    My site www.grainge.org includes many free Authoring and RoboHelp resources that may be of help.

     

    Use menu (bottom right) to mark as Best Answer or to Highlight particularly useful replies. Found the answer elsewhere? Share it here.
    BarryMVAuthor
    Inspiring
    April 4, 2023

    Thanks, Peter.  Sounds like a better-safe-than-sorry situation.

    Peter Grainge
    Community Expert
    Community Expert
    April 3, 2023

    There are arguments for and against. I'll reply in more detail in the morning. 

    ________________________________________________________
    My site www.grainge.org includes many free Authoring and RoboHelp resources that may be of help.

     

    Use menu (bottom right) to mark as Best Answer or to Highlight particularly useful replies. Found the answer elsewhere? Share it here.
    BarryMVAuthor
    Inspiring
    April 3, 2023

    Fair enough.  I look forward to hearing more on this subject.  Thank you, gentlemen.

    Jeff_Coatsworth
    Community Expert
    Community Expert
    April 3, 2023
    BarryMVAuthor
    Inspiring
    April 3, 2023

    I appreciate the link!  Thanks, Jeff.
    Peter's notes seem to be accurate but may be incomplete.  For example, I notice that .ssl files are modified every time the project is built but it is not listed in the notes.  Maybe this file type is unique to Microsoft HTML (ie CHM) output?  In any case, it's just another loose end.  Or did I miss something?

    Jeff_Coatsworth
    Community Expert
    Community Expert
    April 3, 2023

    No, I think the .ssl files are the Single Source Layouts - if you don't Generate & Save, then I don't think the date stamp changes on them. Nothing to do with CHMs.