GitHub Repository

From ShieldsUpNZ
Jump to navigation Jump to search

We have a GitHub repository for our public material, it contains the various bits and pieces we all need as makers and distributors.

Presently the focus has been on documentation and production files needed and will form an important part of version control as we refine things. As the team grows and access to a wider range of information is needed, this will expand.

If you follow the link, you'll need to set up yet another account which is free, once there click watch and star so you can easily find it and get notified as things change.

For those comfortable with terminal and the command line, Github has excellent tools for doing the work for you with pulling changes from the repo as they happen.
Happy to help where I can with this. Slack me on @J-P Hale; Printer, Github Repo Author, General Connector of People
ShieldsUp GitHub

The crash course on GitHub is:

You need git tools installed on your system for the command line. GitHub has GitHub Guides and is an easy place to start.

Once you have GitHub tools available you can do the following

From the command line:

  • Move to the folder you want to hold the GitHub repo in, you want to pull down the repository type the command
git clone JHale716/ShieldsUpNZ
  • This will set up a folder called ShieldsUpNZ and copy the full repo into it.
  • When you CD in the folder
cd ShieldsUpNZ
  • You can then run the basic git tools to manage updates

If you are going to send stuff back tot he repo, contribute material, it is likely that you will need to setup username and password details for this, it is in the wiki for GitHub.
I had a bit of fun setting this up. If you are just a user, then the git pull process will be all you need and you won't need to setup username password locally.

The general commands you will use:

git pull

Will pull the current online version to you. (need to do this before a push)

git add --all

Will add any files you have added to the folders to the repo for upload

git commit --add

Will commit the upload, you will need to give it an explanation on what is being changed

git push

Will send the files and changes to the repo for inclusion.

  • Keep in mind the maximum file uploads are 100MB, you will get a warning if you try and upload a file over 50MB, and a failure on anything over 100MB
  • If you have committed a file greater than 100MB, you will get into a loop, there are ways around this, but the simple fix is trash your local copy and re-clone (preserving any changed files to add back in after)

That's the basics...