Maintainer_Guide_GitLab_to_GitHub.md

Maintainer Workflow: Synchronizing GitLab and GitHub Repositories

This guide is intended for maintainers of both the GitLab and GitHub repositories. The GitHub repository (<remote>) serves as the primary codebase, while the GitLab repository (origin) is the secondary repository. However, due to JATIC program requirements, primary development must occur on GitLab. This process provides a workaround to ensure that GitHub (<remote>) remains the primary codebase while complying with development requirements on GitLab.

Steps

1. Clone the Repository Clone the repository from GitLab (this will be your origin remote):

   git clone [email protected]:jatic/kitware/xaitk-saliency.git

   This step only needs to be done once.

2. Add Upstream Remote Repository Add the GitHub repository as an upstream remote repository named <remote>:

   git remote add <remote> [email protected]:XAITK/xaitk-saliency.git

   This step only needs to be done once.

3. Sync Local Branch Ensure your local branch main is up-to-date with origin/main:

   git fetch origin
   git checkout main
   git pull origin main

4. Push to Remote Repository Push your main branch to the <remote> remote:

   git push <remote> main

5. Create a Pull Request Open a pull request from main to the target branch on the <remote> remote repository.

6. Follow Contribution Guidelines Refer to CONTRIBUTING.md for details on pull request code reviews and merging.

7. Mirror Updates to Origin Ensure origin/master mirrors <remote>/master.

   This process happens automatically but may take a few minutes to reflect changes.

8. Update Local Master Branch Sync your local master branch with origin/master:

   git fetch origin
   git checkout master
   git pull origin master

9. Switch to Main Check out your main branch:

   git checkout main

10. Rebase Master onto Main Rebase <remote> onto main:

    git rebase master

11. Push Main to Origin Push the updated main branch back to the origin remote:

    git push origin main