Scrivener File on GitHub

User avatar
Oogiem
Posts: 32
Joined: Sat Nov 13, 2010 6:24 pm
Platform: Mac
Location: Western Colorado
Contact:

Thu Dec 18, 2014 5:09 pm Post

THought I'd post a few notes about using GitHub as a way to track a Scrivener Document.

I started with this wonderful stub from GitHub

https://github.com/carsomyr/scrivener_starter

I pulled this down to use as a base for putting my own Scrivener based project up in my own repository.

I successfully created a local repository and got the scrivener connection working but had problems getting it back up here on GitHub in my own place. Everything I tried wanted to make changes to eh Master Branch at carsomyr's repository.

So the fix for that slight problem is this:

You have to create an empty repository here on Github first and then edit the config file in your local repository to point to the newly created but empty repository on GitHub.

I edited the line url = https://github.com/carsomyr/scrivener_starter.git
in the config file by replacing carsomyr/scrivener_starter with my Username and the name of my newly created repository.

I am on a Mac and I then used GitHub for Mac to make the connection and manage the commits as I edit my Scrivener file.

So far it's working well.

I'm using Scrivener to write the documentation for my open source sheep flock management software LambTracker.

lo
lolajl
Posts: 61
Joined: Tue Aug 27, 2013 3:54 pm
Platform: Mac

Fri Dec 19, 2014 2:56 pm Post

Heeeeeyyyy . . . do I know you from somewhere, oogiem? ;-)

User avatar
robertdguthrie
Posts: 3075
Joined: Mon Nov 09, 2009 10:06 pm
Platform: Mac
Location: St. Louis, MO, USA
Contact:

Fri Dec 19, 2014 3:51 pm Post

I assume you know not to try and merge two scrivener projects, right? Because of how the .scrivx file keeps up with binder names vs. how Scrivener creates numbered .rtf files which can be entirely different documents in two versions of the same project?

I've seen a couple of people assume that they could collaborate with someone else using Github as a proxy, but merging two branches of the same project can spell disaster if you're both creating new binder entries.
Often wrong, rarely in doubt.
Time for a change... I'm now rdale; same dog-avatar, same dog... channel?

User avatar
Oogiem
Posts: 32
Joined: Sat Nov 13, 2010 6:24 pm
Platform: Mac
Location: Western Colorado
Contact:

Sat Dec 20, 2014 3:37 pm Post

Yeah I suspect that merging will be an issue. But in my limited testing as long as the binder entries are not added to then you can merge. I'll do more testing but it seems to be working that way.

What I'm doing is assuming that I, as the master, will control all binder creation tasks but others appear to be able to edit the individual pieces and I can merge them.

However, I only did one simple test, not very extensive so YMMV.
Last edited by Oogiem on Sat Dec 20, 2014 3:39 pm, edited 1 time in total.

User avatar
Oogiem
Posts: 32
Joined: Sat Nov 13, 2010 6:24 pm
Platform: Mac
Location: Western Colorado
Contact:

Sat Dec 20, 2014 3:37 pm Post

lolajl wrote:Heeeeeyyyy . . . do I know you from somewhere, oogiem? ;-)

Yeah I think so, Black Sheep and all ;-)

di
dissidently
Posts: 3
Joined: Thu Mar 03, 2011 4:04 pm
Platform: Mac

Wed Feb 18, 2015 6:55 pm Post

Is this the only way to do collaboration with a Scrivener file?

Hu
Hugh
Posts: 2444
Joined: Thu Mar 08, 2007 12:05 pm
Platform: Mac
Location: UK

Thu Feb 19, 2015 4:15 pm Post

dissidently wrote:Is this the only way to do collaboration with a Scrivener file?


This has been discussed fairly extensively in these forums. It would be worth doing a search using, say, the term "collaboration". One thread you'll turn up is this one: http://www.literatureandlatte.com/forum/viewtopic.php?f=4&t=4236&hilit=collaboration, which is worth reading all the way through. In that thread, it's pointed out that "serial collaboration" (read the thread for a definition) is already possible - and not necessarily using GitHub. But that's perhaps not what you're seeking. You may mean "parallel collaboration".

One potentially limiting or complicating factor is that a Scrivener "file" isn't in fact a file - it's a folder containing possibly hundreds of files, all of which contribute to a single Scrivener "project". Getting all those files to "work" together if being amended simultaneously in separate locations would increase the difficulty of "parallel collaboration".
'Listen, some quiet night, when you've shirked your work that day. Do you hear
that distant, almost inaudible clicking sound? That's one of your
competitors, working away in the night in
Paris or London or Erie, PA.'

se
seanodaniels
Posts: 2
Joined: Thu May 22, 2014 8:29 pm
Platform: Windows

Fri Feb 20, 2015 10:12 pm Post

Oogiem :

It is good to see someone else using a Distributed Version Control System for their Scrivener work. I was doing the GitHub thing for a while, but I decided that I did not want anyone, including GitHub, to have access to my work.

I ended up setting up Git on my local machine at home and my laptop. I also created a bare repository on my home machine. I do pushes and pulls to this from my desktop, and I can do the same with my laptop by remoting into my home machine using DynDNS and Cygwin from anywhere that provides an internet connection. I even use Sourcetree to do my pushes and pulls.

I have to say that having 0% worry about losing my project is such a relief, as is the capability to not only retrieve a backup, but to retrieve a backup from practically any day in the past.

The tradeoff is that it is a fairly complicated process to set up. One day, I will write a clear tutorial.