Preferred development workflow with git repository:

...

Accelerator Physics Software Work Tracking

Projects/Upgrades

Bug Fixes

Standby Tasks / Wishlist / Brainstorm

...

These are software tasks that are in an unknown state or not currently being worked

...

Software Development Workflow

All production software must be under some form of version control. In general: code with a larger audience of users or that is a significant dependency of downstream software should be managed more carefully.

Master repositories can be found here: /afs/slac/g/cd/swe/git/repos/slac/FACET/

"Production" HLAs live in a number of location, mainly $TOOLS/python and $TOOLS/matlabTNG

How to create a new repo

1. navigate to the /afs/ prod directory and mkdir <repo_name>.git
2. run git init --bare to instantiate a new empty repo
3. (if using GitHub) make a new GitHub repo with the same name
4. clone the master repo into a work directory (can be anywhere, /afs/-space, DMZ or prod): git clone ssh:///afs/slac/g/cd/swe/git/repos/slac/FACET/<repo_name>.git
5. do work, then git commit & git push
6. (after implementation/deployment) clone the master repo into a production repository

Once you create a new repo or clone one, there are two workflows: one simple command-line only way to use git, or also using the SLAC GitHub to enable some more formal code review processes.

Repo mirroring with GitHub:

GitHub is hosted on the public internet. In order to store production software there, we need to use a "relay" repo that lives on the DMZ network to facilitate pushing/pulling changes between GitHub and the local repo on the SLAC network. 

1. ssh to centos7, navigate to /u/gu/zack/github_relay/
2. run python relay_setup.py <prod_repo_name> <github_repo_name> to setup a "relay repository" used to sync /afs/ and GitHub. This script will:
   1. git clone the repo into the github_relay directory
   2. git add remote github git@github.com:slaclab/<github_repo_name>.git
   3. add <repo_name> to /u/gu/zack/github_relay/tracked_repos.txt

Direct push to master (for minor changes or lower-impact software):

1. from your work directory: git commit, git push origin master
2. from the production directory, and git pull origin master

Feature-branches with GitHub (for major changes or high-impact software):

This process will be automated in future, but for now relies manually using the script: /u/gu/zack/github_relay/sync_github.py

1. Setup relay mirroring to GitHub as described above
2. from your work directory for the repo in question, make a new branch: git branch <branch_name>
3. make changes, commit them to <branch_name> and push the branch to origin

To deploy software to production

1. run git pull origin master in the production repository

Using sync_github.py

• to sync prod → GitHub: $ python sync_github.py push <repo name> <(optional) branch name>
• to sync GitHub → prod: $ python sync_github.py pull <repo name> <(optional) branch name>

...

Legacy Task Tracking

These are the HLA tasks as they existed as of 01/2024. This list content is archival.

Preferred development workflow with git repository:

• Create new development branch for work in personal clone of repo
• Do work and test
• Merge in any recent changes from main branch
• Push your branch, email Glen to evaluate & merge into main branch

Generic tasks/ideas

...