Developing For Runsafe - Revision history

Docpify at 21:15, 21 June 2014

2014-06-21T21:15:14Z

← Older revision		Revision as of 21:15, 21 June 2014
Line 115:		Line 115:
	== Step 6: Keeping Up-to-date! ==		== Step 6: Keeping Up-to-date! ==
	Rather than have to repeat EVERYTHING when you want to make a change, simply go back to step 2D and pull the code into your repository. You should make sure your repo is up-to-date before starting to edit it, otherwise this is a quick way to run into conflict errors.		Rather than have to repeat EVERYTHING when you want to make a change, simply go back to step 2D and pull the code into your repository. You should make sure your repo is up-to-date before starting to edit it, otherwise this is a quick way to run into conflict errors.

			== Appendixes ==
			=== Git Bash tips and tricks ===
			==== Updating all your repositories ====
			If you want to update all your repositories, you can do it all with a single command with the power of bash!
			Open Git Bash on the folder containing your repositories and run this command;

			<code> for i in */.git; do (cd $i/..; pwd; git pull); done </code>

			==== Checking all your repositories for uncommitted changes ====
			Again, open Git Bash on the folder containing your repositories and run this command;

			<code> for i in */.git; do (cd $i/..; pwd; git status); done </code>

			==== Pushing all your repositories to github ====
			Once again, open Git Bash on the folder containing your repositories and run this command;

			<code> for i in */.git; do (cd $i/..; pwd; git push); done </code>

			.. Maybe you've spotted the pattern by now?

Docpify: /* Steo 1D: Generating an SSH key */

2014-06-21T21:11:18Z

Steo 1D: Generating an SSH key

← Older revision		Revision as of 21:11, 21 June 2014
Line 37:		Line 37:

	This will create a new folder ".ssh" in your home directory. You need to add the public key from this folder to your github account.		This will create a new folder ".ssh" in your home directory. You need to add the public key from this folder to your github account.

	~~Now you're done, you can close the git console window.~~

	== Step 2: Grabbing a Project ==		== Step 2: Grabbing a Project ==

Docpify: /* Step 1: Git */

2014-06-21T21:10:55Z

Step 1: Git

← Older revision		Revision as of 21:10, 21 June 2014
Line 28:		Line 28:

	<code>git config --global user.email "your_email@example.com"</code>		<code>git config --global user.email "your_email@example.com"</code>

			=== Steo 1D: Generating an SSH key ===
			If you already have one, you can skip this step

			Run this command:

			<code>ssh-keygen</code>

			This will create a new folder ".ssh" in your home directory. You need to add the public key from this folder to your github account.

	Now you're done, you can close the git console window.		Now you're done, you can close the git console window.

Docpify: /* Step 5A: Push changes... */

2014-06-21T21:05:53Z

Step 5A: Push changes...

← Older revision		Revision as of 21:05, 21 June 2014
Line 94:		Line 94:

	git push origin master</code>		git push origin master</code>

			A good commit message should describe why you made the change, in less than 50 characters. Don't bother listing what changed in the code, the commit diff will cover that perfectly well on its own.

	Please note that "Changes" is not a valid commit message and we will most likely reject it, we should be able to figure out exactly what you've done with the commit message. Check commits by Kruithne and docpify for examples of how to make decent commit messages. Providing everything goes well, your changes should now have been pushed to your GitHub fork of Cheeves, or whichever plug-in you are using for this guide.		Please note that "Changes" is not a valid commit message and we will most likely reject it, we should be able to figure out exactly what you've done with the commit message. Check commits by Kruithne and docpify for examples of how to make decent commit messages. Providing everything goes well, your changes should now have been pushed to your GitHub fork of Cheeves, or whichever plug-in you are using for this guide.

Docpify: /* Step 3B: Grab the Framework (and it's libraries) */

2014-06-21T21:04:04Z

Step 3B: Grab the Framework (and it's libraries)

← Older revision		Revision as of 21:04, 21 June 2014
Line 63:		Line 63:

	=== Step 3B: Grab the Framework (and it's libraries) ===		=== Step 3B: Grab the Framework (and it's libraries) ===
	Follow this step carefully! Go to our Jenkins page for the framework (https://jenkins.runsafe.no/job/Framework/) and on the ~~left hand side~~ you will see a ~~list of latest builds~~, ~~select the highest one which has~~ a ~~blue icon next~~ to ~~it. Red icons mean~~ the ~~build failed, don't select one~~ of ~~these~~. ~~Once you're clicked on the latest successful build, look under '''Build Artifacts''' for~~ '''framework.jar''' ~~and~~ download it. The framework JAR file that gets downloaded should be placed in a folder name '''out''' placed NEXT to your repository, like in the image below.		Follow this step carefully! Go to our Jenkins page for the framework (https://jenkins.runsafe.no/job/Framework/) and on the middle of the page, you will see a package icon, with a link to the Last Successful Artifacts of the job. In this case; '''framework.jar''' click to download it. The framework JAR file that gets downloaded should be placed in a folder name '''out''' placed NEXT to your repository, like in the image below.

	[[File:Dev_guide_7.png]]		[[File:Dev_guide_7.png]]

Kruithne: /* Step 3B: Grab the Framework (and it's libraries) */

2014-06-20T04:27:22Z

Step 3B: Grab the Framework (and it's libraries)

← Older revision		Revision as of 04:27, 20 June 2014
Line 63:		Line 63:

	=== Step 3B: Grab the Framework (and it's libraries) ===		=== Step 3B: Grab the Framework (and it's libraries) ===
	Follow this step carefully! Go to our Jenkins page for the framework (https://jenkins.runsafe.no/job/Framework/) and on the left hand side you will see a list of latest builds, select the highest one which has a blue icon next to it. Red icons mean the build failed, don't select one of these. Once you're clicked on the latest successful build, look under '''Build Artifacts''' for '''framework.jar''' and download it. The framework JAR file that gets downloaded should be placed in a folder name '''out'' placed NEXT to your repository, like in the image below.		Follow this step carefully! Go to our Jenkins page for the framework (https://jenkins.runsafe.no/job/Framework/) and on the left hand side you will see a list of latest builds, select the highest one which has a blue icon next to it. Red icons mean the build failed, don't select one of these. Once you're clicked on the latest successful build, look under '''Build Artifacts''' for '''framework.jar''' and download it. The framework JAR file that gets downloaded should be placed in a folder name '''out''' placed NEXT to your repository, like in the image below.

	[[File:Dev_guide_7.png]]		[[File:Dev_guide_7.png]]

Kruithne: /* Step 3B: Grab the Framework (and it's libraries) */

2014-06-20T02:54:57Z

Step 3B: Grab the Framework (and it's libraries)

← Older revision		Revision as of 02:54, 20 June 2014
Line 70:		Line 70:

	<code>git init		<code>git init

	git pull https://github.com/Runsafe/Framework.git</code>		git pull https://github.com/Runsafe/Framework.git</code>

Kruithne: /* Step 5A: Push changes... */

2014-06-20T02:54:42Z

Step 5A: Push changes...

← Older revision		Revision as of 02:54, 20 June 2014
Line 89:		Line 89:

	<code>git add -A		<code>git add -A

	git commit -m "COMMIT MESSAGE HERE"		git commit -m "COMMIT MESSAGE HERE"

	git push origin master</code>		git push origin master</code>

Kruithne at 01:50, 20 June 2014

2014-06-20T01:50:07Z

@@ Line 47: / Line 47: @@
 '''TIP:''' To paste into the Git console window, you can paste by right-clicking on the title bar, go to '''Edit''' and select '''Paste'''.
 Now we can pull the code down rather easily using the following command.
@@ Line 58: / Line 60: @@
 === Step 3A: Download ===
-Navigate to the download page for IntelliJ (http://www.jetbrains.com/idea/download/) and select the community edition (it's free)
+Navigate to the download page for IntelliJ (http://www.jetbrains.com/idea/download/) and select the community edition (it's free) and follower the installer through. Once it's installed, don't run IntelliJ just yet, we've got some more things to do!
-''' THIS GUIDE IS INCOMPLETE, MORE COMING SOON! '''
+== Step 6: Keeping Up-to-date! ==

Kruithne: /* Step 2: Grabbing a Project */

2014-06-19T23:13:54Z

Step 2: Grabbing a Project

← Older revision		Revision as of 23:13, 19 June 2014
Line 50:		Line 50:
	Now we can pull the code down rather easily using the following command.		Now we can pull the code down rather easily using the following command.

	<code>git pull master</code>		<code>git pull origin master</code>

	It shouldn't take too long and when it's done, all of the code for the repository will be inside your folder. Keep the Git console window open, as we'll need it again later.		It shouldn't take too long and when it's done, all of the code for the repository will be inside your folder. Keep the Git console window open, as we'll need it again later.