Quick-Start Guide

1. Install Git X-Modules from the Atlassian Marketplace.

2. Open your main working repository or create a new one.

3. Click on the “Git X-Modules” icon in the left menu.
   

4. Select the branch you would like to add external (“module”) files to, and click “Add module”

   

   image960×794 37 KB

   
   

5. In the new window, select:

• the repository fo add files from (“module”);

• the branch in the module repository to add files from;

• whether you would like to include module files read-only (“fetch only”) or to update external modules from time to time (“fetch and push”);

• the directory to add module files to.

  

  2020-04-17_12-57-511043×955 37.3 KB

  
  

• You may also pin your new module to a specific tag or commit in the external repository.

  

  2020-04-17_13-07-181018×932 47.3 KB

  
  

1. Select the merge strategy you would like to use (see more information here).

2. Click “Add module”. The new module will appear in the list. You may check and edit the module settings if needed.

   

   image1125×428 16.9 KB

   
   

3. When you’re ready, click “Apply changes”. The files you’ve selected will be added to your repository.
   Git X-Modules will automatically check the source (“module”) repository and fetch updates to these files, if any.

   To change your module settings, hover on the module in the list and click the “Edit” button.

   To remove the module, hover on the module in the list and click the “Delete” button.

   

   image1461×569 30.6 KB

   
   

That’s all! Enjoy this smooth, safe, stress-free way to work with external sources right from your repository.