PLC Source Control - Working with GIT and TcXaeShell

Tutorial that outlines the steps that make up a typical TcXaeShell development cycle with GIR source control

Difficulté

Hard Difficile

Durée

1 hour(s) heure(s)

PLC, Source Control, GIT

Introduction

These steps outline typical actions that make up a development cycle for changing code on a machine, saving changes locally and saving to the cloud repository using Git as the Source control tool.

• Tutoriels prérequis

Tutoriels prérequis

PLC Source Control - Create a Development Branch

PLC Source Control - Selecting GIT as the source control Plug-in

Étape 1 - Making a branch

Create a branch locally to hold the code involved with the changes.

See document for Making a Branch

The branch name is made up of three parts:

1. Machine Reference S095_ followed by an underscore character _
2. Service Job Number 1234567890_ followed by an underscore character _
3. Text that identifies the change eg. Infeed Mod, Outfeed Bug Bix, Timer Mod.

There may be more than one branch for the changes under the service job. This method of naming aids traceability. For example S095_123454321_ClampMod and S095_123454321_InfeedTiming are two branches under the same job number.

Étape 2 - Saving the changes

1. The change has been saved as a local change.
2. Press Sync to save the changes to the cloud repository. This ensures that the local Branch is now being tracked as a branch being attached to Remote repository

Étape 3 - Pushing changes to the Cloud Repo

1. Select Push
2. Message appears showing the successful push to the Origin which is in the remote cloud Repo

Étape 4 - Add More Changes and Commit

1. Add more changes to the code,
2. Select Home then Changes this shows the commit message (Required)
3. Enter the message and add the Machine and Job Number to the message
4. Push Commit , this Commits the changes locally

This cycle of changing code and pushing to the cloud can be extensive and can cover many hours work. By pushing to the cloud the work is backed up and code can be restored if needed.

Étape 5 - Pushing the changes to the Remote Repository

1. To save the changes to the remote repository select Sync
2. Commits ready to be pushed to the Cloud
3. Select Push to send the changes

When complete the remote branch repository will contain all the changes made and committed to the local branch

Steps 4 and 5 can repeat many times during a development cycle

Étape 6 - Setting up for Merging the Branched code

1. Make sure all changes have been committed and pushed steps 4 and 5
2. Select Home then select Branches
3. Mouse click on master when it is selected it will be in bold text. If this does not work and there is an error message, the most likely cause is there are committed changes waiting to be pushed to the cloud Repo. go back to steps 4 and 5 and push the remaining changes.
4. Press Merge to open the merge window.

Étape 7 - Merge

1. From the dropdown Menu select the branch to be merged
2. Keep the option : Commit changes after merging checked
3. Press Merge
4. Message to say merge is complete:.

...The merge is complete on the local repository, Press Sync to update the remote Repo

Étape 8 - Sync

1. Sync lists the commits that need to be pushed to the Remote Repo Origin
2. Press Push
3. Message indicating successful push to origin master

Étape 9 - Up to date

The local branch has been updated and merged with the local master and the remote branch and master repository match (same change level)

en none 0 Draft