Configure GitHub External Plugins

This topic explains how to configure GitHub external plugins with Agility.

Introduction

The agilitysync-externalplugins repository is hosted on GitHub. To get a copy of the source code you must fork the agilitysync-externalplugins repository on GitHub, create a local clone of your personal fork, and configure the remote systems.

You must execute these steps once per machine:

1. Go to https://github.com/digital-ai/agilitysync-externalplugins.
2. Press Fork on the top right.
3. When prompted where to fork the repository, choose to fork it to your username.
4. Your fork will be created at https://github.com/<username>/.
5. Clone your GitHub fork (replace <username> with your username):
   • git clone git@github.com:<username>/agilitysync-externalplugins.git
   • You can use both SSH-based orHTTPS -based URLs
6. Add an upstream remote, then configure git to pull main from upstream and always push to origin:
   • cd agilitysync-externalplugins
   • git remote add upstream https://github.com/digital-ai/agilitysync-externalplugins
   • git config --local branch.main.remote upstream
   • git remote set-url --push upstream git@github.com:<yourusername>/agilitysync-externalplugins.git
7. Verify that yoursetup is correct:
   • $git remote -v
   • origin git@github.com:<your-username>/agilitysyncexternalplugins.git fetch)
   • origin git@github.com:<your-username>/agilitysyncexternalplugins.git (push)
   • upstream https://github.com/digital-ai/agilitysyncexternalplugins (fetch)
   • upstream git@github.com:<your-username>/agilitysync-externalplugins.git (push)
   • $git config branch.main.remote

Procedure to Create a Repository for External Plug-in

1. Update data from your upstream repository
   • git fetch upstream
2. Create a new branch in your local clone from the main branch in the upstream repository:
   • git checkout -b <branch-name> upstream/main
3. Once you are satisfied with the changes, add the files and commit them:
   • git add <filenames>
   • git commit -m '<message>'
4. Then push your work to your GitHub fork:
   • git push origin <branch-name>

Finally go on https://github.com/[your-username]/agilitysync-externalplugins: you will see a box with the branch you just pushed and a green button that allows you to create a pull request against the official agilitysync-externalplugins repository.

Review Process

This Product Request will be reviewed by Agility Sync core team, once the PR is approved, testing is done, after which the plugin will be merged into Agility Sync external plugin repository.