Skip to content
Snippets Groups Projects

Git workflow

Last edited by Eesaan Atluri

Workflow

All projects reside in https://gitlab.rc.uab.edu/rc

Terminology

  • repo - project space containing your code.
  • upstream - main repo which is the source of authority for the code
  • fork - copy of the upstream repo.
  • worktree - local project dir on your machine.

Git Workflow

  1. Create your own fork of the upstream repo if one doesn't exist.
  2. Create a new branch and start editing files in your work tree.
  3. Commit changes in smaller and logical increments to the feature branch.
  4. All commits are made to the feature branch.
  5. When ready push the feature branch to your forked repo.
  6. Open a pull/merge request to the default branch, usually it is main and is inherited from the upstream repo
  7. Open a pull/merge request against the upstream repo if you/team wants the visibility. Make sure you have a draft tag in front of it, so it is not accidentally merged.
  8. Let the CI/CD pipeline run in your repo. After a successful pipeline run open a merge request against the upstream repo
  9. If the pipeline in the upstream succeeds, it is ready for testing.
  10. Once tested thoroughly merge the PR/MR.