CMS Sync Procedure
The CMS Sync procedure reconciles any changes made by the end user clients with the server GitHub repository. If this is not done, any server updates made by the developer will erase/remove end user changes. As such, it's important to do these syncs before working on areas in the feed and periodically.
cms-sync-1 command
Before starting this procedure, make sure that your git status is clear and/or all changes are pushed up to the shared repo. In addition, inform any other developers you may be sharing access with to not push changes or merge anything with the main branch during this time.
Begin by running the following command:
./foreground.sh kipo 00100 cms-sync-1
and replace
kipo
with the name of your deployment.
Enter your password when prompted.
There will be a few warning prompts reminding you of the steps you should take before starting; enter
y
at the prompts to continue.
## Sync CMS Changes from production servers. ##
Are you up to date on changes?
- git pull
- publish changes to production for kipo : 01000
y
Next prompt
You are on branch: master
Have you notified your teammates that a sync is in progress? (no team commits during sync)
y
Next prompt
ssh session open: com.jcraft.jsch.Session@63355449
ssh session open: com.jcraft.jsch.Session@63355449
ssh channel open: 0
Last Sync: 79e1e6fda6c0bd7d4ea83812dbfe34b88089648a
Current commit: 749ed6d88212608f4c692deedbf782900fd47403
Must sync any local changes with production first. Proceed with sending updates to server?
y
Rest of script fires
Waiting on updates to production
20251208T230908274Z 000000000000005 M03 |OpId|00130-20251208T230850219Z-000000000000006| New operation context
Last Sync: 79e1e6fda6c0bd7d4ea83812dbfe34b88089648a
You are on branch: master
. . .
After this procedure is done, run a
git status
check to review files that will be merged for any excessively large files/potential issues. (See Troubleshooting for more info)
save updates to the repo
Commit and push the changes to the repo. The steps below can be used for reference.
git add .
git commit -m "notes"
git push
cms-sync-2 command
At this point, your local files will be synced up with the changes the end user has made, so save the files and push up to the repo branch you're working with.
Then, run the following command:
./foreground.sh kipo 00100 cms-sync-2
Enter your password when prompted.
Again, enter
y
at the prompts to continue:
## Sync CMS Changes from production servers - final step. ##
Have you commited and pushed your sync?
- review commit for cfac
- git push
y
Rest of script fires
Current commit: 940ca98af6a462731af832817a85ffbb51d89c68
ssh session open: com.jcraft.jsch.Session@245b4bdc
ssh session open: com.jcraft.jsch.Session@245b4bdc
ssh channel open: 0
ssh channel exit: 0
ssh session disconnect: com.jcraft.jsch.Session@245b4bdc
Sync is complete!
After this procedure is complete, the sync procedure is done and you can alert your dev team that the branches are available to receive commits again.
Troubleshooting
TODO
Issues with deposit hangs