Using Versions with GitHub

Connecting Versions to GitHub

Signing up with a GitHub account

After you install and run Versions desktop application, then choose GitHub as a Sign In option.

choose GitHub
You will be redirected to GitHub to authorize Versions application to access your account.

Connecting your GitHub account to an existing Versions account

In case you already have Versions account, go to your Account Settings and click “Sign in with GitHub”.

Sign in with GitHub
You will be redirected to GitHub to authorize Versions application to access your account, and your GitHub account will be linked to your Versions account.

Creating GitHub-stored project in Versions

Projects in Versions look and feel as a regular folders, while on under the hood it’s connected to actual version control system.

To create a project, in a new project dialog fill the name of the project, optional description and choose a working directory for it. By default, your projects will be stored in your Documents folder.

Select GitHub as a service to store your files at, and choose a team(if any) to own the project. For paid GitHub subscribers, there is an option to make a project private.

Creating GitHub-stored project in Versions

Working with projects

To start working with the project, open a working directory with “Reveal in Finder” button on a project card.

Working with projects

Then, move your Sketch mockups to the working folder. Once you do that, you’ll notice that files now have a status indicators, which are described below.

File statuses

File statuses

Publishing updates to GitHub

First, you need to make sure your files are tracked. To do so, select a files with ? status in Finder, and in the context menu select “Add File”.

Select a files

Then, provide some context on what this mockup are for or what you were working on and hit “Upload”.

Provide some context

Congratulations! Your mockup is now published, so you can collaborate on it with your team.

Sharing with your Team

Open Members tab in the project’s dashboard, and then click on “Manage in Web App”. At the moment, team management is only available there.

Manage in Web App

In the web app, you can invite new team members via email and set their access level(Read only, Write or Admin) using “Share Project” button:

Share Project