Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

GitHub Quick Start

Jump to bottom
Thavanathan Thangaraj edited this page Oct 5, 2020 · 8 revisions

  1. GitHub sspl's repo link

  2. GitHub authentication method (Use anyone for the authentication)

    1. Using HTTPS connection

      Generate access token in the GitHub UI.

      1. https://github.com/settings/tokens
      2. Enable SSO
    2. Using SSH key

      Generate ssh key and add public key in the GitHub UI.

      1. ssh-keygen -t rsa
      2. https://github.com/settings/keys
      3. Enable SSO

  3. Create a personal repo from the cortx-sspl repo

    Use GitHub UI to fork repo from cortx-sspl repo.

  4. Clone forked Repo in the local machine

    git clone git@github.com:"GitHub UserId"/cortx-sspl.git Remember to update your username and email in git config.

git config --global user.name "FIRST_NAME LAST_NAME"
git config --global user.email "MY_NAME@example.com"

If you are using different repositories with different email ids, then --global is not a good idea. Go to SSPL directory and then run the above commands in that directory without --global option.

  1. Create a feature branch in the local repo from the master. Make sure your master branch is up to date with the upstream master. Follow the sync up steps to update local master when your local master is behind with upstream master

    git checkout -b "feature branch"

  2. Do the code changes

  3. Stage your local changes

    git add "File path which are modified"

  4. Commit your staged changes

    git commit -m "commit message"

  5. Push feature branch to the origin(forked repo)

    git push origin "feature branch" (After this command your local feature branch will be visible in the forked repo)

  6. Create a pull request from the feature branch of the forked repo(origin repo) against the master branch of Seagate/sspl(upstream repo) using GitHub UI. Make sure that all the local changes are available in the origin "feature branch". You can verify your changes from the GitHub UI itself from the origin branch commit history.

  7. Submit changes once it's approved (Two approvals are required, it's configurable we can change it based upon our need)

  8. Jenkins job will get triggered automatically after every check-in in the master of Seagate/sspl.

    http://eos-jenkins.colo.seagate.com/job/Release_Engineering/job/github-work/job/SSPL/

Setup upstream repo in the remote list ( It's one-time activity )

  • git remote -v (See the current configured remote repository for your fork.)

  • git remote add upstream git@github.com:Seagate/cortx-monitor.git

  • git remote -v (Upstream repo should be visible)

Sync origin master with upstream master

  • git fetch upstream (Fetch the branches and their respective commits from the upstream repository)
  • git checkout master
  • git rebase upstream/master or git merge upstream/master (rebase is preferred)
  • git push origin master

Sync origin feature branch with upstream master

  • git fetch upstream (Fetch the branches and their respective commits from the upstream repository)

  • git checkout "feature branch" (In case you are not in your feature branch)

  • git rebase upstream/master or git merge upstream/master (rebase is preferred)

  • git push origin "feature branch"

  • Note: Sometimes, It fails to push local branch changes to origin after rebase. Use --force option to push it forcefully. Follow below link for the more detail:

    https://stackoverflow.com/questions/8939977/git-push-rejected-after-feature-branch-rebase

Forcefully reset your branch with upstream master

  • git pull --rebase upstream master
  • git reset --hard upstream/master
  • git push origin master --force

Developer workflow link shared by DevOps Team

Clone this wiki locally