Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • General Git workflow to push changes to central repo: add, commit, fetch*, pull, push 
    *git fetch is optional, but recommended in the event of multiple developers working in the same repo. Via StackOverflow:

    git fetch updates your local copy of the repository but does not modify any files in the working directory. It simply makes sure that the cached info it has about the repository you fetched is up-to-date. (If other people created new branches or added some commits since the last time you fetched, git will learn about them.)

    git pull is shorthand for git fetch followed by git merge FETCH_HEAD. That is, it runs git fetch and then merges the changes from the remote repository into your current branch and working directory.

    Code Block
    [sgess@rhel6-64a ~/sgess/git_work/matlabTNG ]$ vim README.md
    [sgess@rhel6-64a ~/sgess/git_work/matlabTNG ]$ git add README.md
    [sgess@rhel6-64a ~/sgess/git_work/matlabTNG ]$ git commit -m "example of typical git workflow"
    [sgess@rhel6-64a ~/sgess/git_work/matlabTNG ]$ git fetch origin
    [sgess@rhel6-64a ~/sgess/git_work/matlabTNG ]$ git pull origin master
    [sgess@rhel6-64a ~/sgess/git_work/matlabTNG ]$ git push origin master
  • It is good practice to specify the remote repo and branch (e.g., git push/pull origin master), particularly in case there are multiple branches in a repo.
  • Leaving helpful descriptions of changes, bug fixes, etc. is strongly encouraged in your commit messages.
  • When releasing a new repo to the production release area, the remote repo should be specified with the `ssh://` protocol. This will ensure that other FACET-II shared account users (fsoftegr/fphysics) will be able to access the repo and make changes. E.g.:

    Code Block
    [fphysics@facet-srv01 /usr/local/facet/tools/matlabTNG ]$ git clone ssh:///afs/slac/g/cd/swe/git/repos/slac/FACET/matlabTNG/my_new_repo.git
    [fphysics@facet-srv01 /usr/local/facet/tools/matlabTNG ]$ cd my_new_repo && git remote -v
    origin	ssh:///afs/slac/g/cd/swe/git/repos/slac/FACET/matlabTNG/my_new_repo.git (fetch)
    origin	ssh:///afs/slac/g/cd/swe/git/repos/slac/FACET/matlabTNG/my_new_repo.git (push)
  • You may work with repos hosted in cloud services such as GitHub/GitLab/etc, but when deploying code to production you must sync them to the master AFS repos as indicated above. This is typically done as follows:

    1. Sync to local AFS workspace via internet accessible node (rhel6-64, lcls-dev3).
    2. Push to AFS master repo (this can be done by setting different remote repos for fetching and pushing).
    3. Proceed with releasing software to production as indicated above.


Image Added