ATM Games Blog

pushing updates to version control

Nov 05, 20244 min read

Author: Chauncey Mac

Note: This follows tutorial uses Azure DevOps and follows the following Branch Structure: main->staging->dev. See git for unreal on how to set this up. This page is used internally, but feel free to use the same workflow.

Using Github Desktop

Install it if you haven’t already. Github Desktop

Downloading/Cloning Project

  • Install Git Bash for windows.
  • Open git bash type: git lfs install
  • Download Github Desktop if you haven’t already (a github account is probably required)
  • Find the repo you want to clone and click on the clone button in the top right. Then click create git credentials. This will be the username and password used to sign into Github Desktop so save it somewhere. (This password expires so be prepared to do this about every 3 months)
  • Open the clone button again and copy the URL.
  • Open Github Desktop and click add new repository and the URL tab.
  • Paste the URL into the HTTPS box and select a directory where the project will be saved. (It will get pretty big as we keep updating it)
  • Click clone
  • It will ask for username and password. Use your Microsoft email and the PAT you created earlier for the password.
  • If you plan to make changes within the repo be sure to make a make a new branch from dev.

Pushing Changes

  • Check the change-list and make sure it only includes files you wish to update.
  • Add a short commit message that describes what you did.
  • Click commit.
  • Click pull (This will only ever do something if someone else made changes to the same branch which should not happen with our setup, but it’s good practice).
  • Click push (This will upload changes to repo).

Using CLI

If using Windows install Git Bash . If using Linux I assume you know what you’re doing.

Downloading and Cloning Project

  • Open Git Bash.
  • Type: git lfs install.
  • Go to the repo you want to clone and click on the clone button in the top right. Then click create git credentials. This will be the username and password used to authenticate so save it somewhere. (This password expires so be prepared to do this about every 3 months)
  • Open the clone button again and copy the URL.
  • Within your terminal navigate to where the project will stored.
  • Type: git clone <URL> where url is what you copied earlier. (It will get pretty big as we keep updating it)
  • It will ask for username and password. Use your Microsoft email and the PAT you created earlier for the password.
  • If you plan to make changes within the repo be sure to make a make a new branch from dev (see below).

Pushing Changes

  • git status to check the changed files.
  • git add <FILE> to add files you wish to push to the feature branch.
  • git commit -m "<MESSAGE>" Add a short commit message that describes what you did.
  • git pull (This will only ever do something if someone else made changes to the same branch which should not happen with our setup, but it’s good practice).
  • git push (This will upload changes to repo).

When ready to merge feature branch into dev (Pull Request)

  • Make sure all of your changes are committed and pushed (see above).
  • Within Azure DevOps go to Repos→Pull Requests.
  • Click new pull request.
  • Make sure your branch is on the left and dev is on the right: [your branch] into dev
  • Give it a name and a description.
  • @Chauncey Mac will automatically be added as a required reviewer (if you don’t want him to merge as he approves put that in the description).
  • Click Create and wait for @Chauncey Mac to approve.

Graph View

Backlinks