Difference between revisions of "Source Control (GIT)"

From PowerUI
Jump to: navigation, search
(Gaining access)
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
PowerUI's source is available via GIT to everybody with a PowerUI license along with a [https://git.kulestar.com/PowerUI/UnityProject web based Gitlab UI for easy access]. It's highly recommended you set up access as it's easy to do and will keep you right up to date with all the latest changes. Known bugs and feature requests are handled there too.
+
'''We're currently in the process of moving over to public GitHub repo's and a new website - in the meantime, this guide should still work fine!''' PowerUI's source is available via GIT to everybody with a PowerUI license along with a [https://git.kulestar.com/PowerUI/UnityProject web based Gitlab UI for easy access]. It's highly recommended you pull the latest code as it's easy to do and will keep you right up to date with all the latest changes. Known bugs and feature requests are handled there too.
  
 
== Gaining access ==
 
== Gaining access ==
  
* Create an account on [http://powerui.kulestar.com/me/ My PowerUI].
+
* The [https://git.kulestar.com/PowerUI/UnityProject main repository] now supports anonymous clones. Clone it directly but make sure it's recursive - see below!
* Drop in your invoice number from the Unity Asset Store. You can get hold of the invoice number directly from your Unity Asset downloads window, or from the purchase email.
 
* You'll then see a box at the top which can grant you access. Click on the button ''(and expect a small barrage of emails!)''
 
* You can now login to and checkout any of the PowerUI repositories.
 
  
 
== Checking it out ==
 
== Checking it out ==
  
The [https://git.kulestar.com/PowerUI/UnityProject UnityProject repository] contains all of the individual modules, so you'll want to check that one out. '''Make sure you do a recursive submodule checkout'''. The repository uses GIT Submodules (~20 of them), so a recursive checkout will make sure all of them are included for you.
+
The [https://git.kulestar.com/PowerUI/UnityProject UnityProject repository] contains all of the individual components ''as git submodules'', so you'll want to check that one out. '''Make sure it's set to recursive and you do a submodule update''' - here's how via the command line:
 +
 
 +
<syntaxhighlight lang="bash">
 +
 
 +
git clone https://git.kulestar.com/PowerUI/UnityProject.git --recursive
 +
git submodule foreach --recursive git checkout master
 +
git submodule foreach git pull
 +
 
 +
</syntaxhighlight>
  
 
== The wall of errors ==
 
== The wall of errors ==
Line 18: Line 23:
 
== Windows Users ==
 
== Windows Users ==
  
If you're on windows, a common tool to use is TortoiseGIT. Navigate through to the directory you'd like to check it out to, then right click -> "GIT Clone..". Enter the repository URI at the top (https://git.kulestar.com/PowerUI/UnityProject.git). Make sure you tick that "recursive" option! Press ok, then you'll then be prompted for your user details which are those same ones mentioned above. If you get any kind of "git did not exit cleanly" message, then go into the UnityProject folder, right click, and go to TortoiseGIT -> "Submodule update..".
+
If you're on windows, a common tool to use is [https://tortoisegit.org/download/ TortoiseGIT]. Here's a quick guide on using that:
 +
 
 +
* Navigate through to the directory you'd like to check it out to
 +
* Right click -> "GIT Clone..".
 +
* Enter the repository URI at the top (https://git.kulestar.com/PowerUI/UnityProject.git).
 +
* Tick recursive
 +
* Press ok and then let it clone. You might get a '''"git did not exit cleanly"''' message - this is fine!
 +
* Go into the repositories directory. Right click and go to TortoiseGIT -> "Submodule update..".
 +
 
 +
 
 +
Alternately, If you are okay with command line you can grab https://git-scm.com/download/win and use the command line instructions above on windows.
 +
 
 +
== Alternatives ==
 +
 
 +
Note: '''Using the zip option on Gitlab''' still requires you to do a submodule update (as it does on GitHub too).
 +
 
 +
We're working on a new CI/CD pipeline to automatically build Unity packages and hopefully we'll be able to get every future commit packaged up.

Latest revision as of 20:24, 10 January 2018

We're currently in the process of moving over to public GitHub repo's and a new website - in the meantime, this guide should still work fine! PowerUI's source is available via GIT to everybody with a PowerUI license along with a web based Gitlab UI for easy access. It's highly recommended you pull the latest code as it's easy to do and will keep you right up to date with all the latest changes. Known bugs and feature requests are handled there too.

Gaining access

  • The main repository now supports anonymous clones. Clone it directly but make sure it's recursive - see below!

Checking it out

The UnityProject repository contains all of the individual components as git submodules, so you'll want to check that one out. Make sure it's set to recursive and you do a submodule update - here's how via the command line:

git clone https://git.kulestar.com/PowerUI/UnityProject.git --recursive
git submodule foreach --recursive git checkout master
git submodule foreach git pull

The wall of errors

If you see a giant wall of errors, don't panic! That means it hasn't cloned all of the contents of the submodules. Depending on the client you're using, you'll need to go into the directory, and perform a GIT submodule update. Some clients will do that as part of a pull/ update. That should get those submodules for you.

Windows Users

If you're on windows, a common tool to use is TortoiseGIT. Here's a quick guide on using that:

  • Navigate through to the directory you'd like to check it out to
  • Right click -> "GIT Clone..".
  • Enter the repository URI at the top (https://git.kulestar.com/PowerUI/UnityProject.git).
  • Tick recursive
  • Press ok and then let it clone. You might get a "git did not exit cleanly" message - this is fine!
  • Go into the repositories directory. Right click and go to TortoiseGIT -> "Submodule update..".


Alternately, If you are okay with command line you can grab https://git-scm.com/download/win and use the command line instructions above on windows.

Alternatives

Note: Using the zip option on Gitlab still requires you to do a submodule update (as it does on GitHub too).

We're working on a new CI/CD pipeline to automatically build Unity packages and hopefully we'll be able to get every future commit packaged up.