Skip to content

Project Configurations

joannasumner edited this page Jun 30, 2021 · 4 revisions

To benefit from certain GitHelp features, project specific configuration files can be added to a .gitHelp directory in the project root.

.gitHelp/forkDevelopers.ini

The Fork Developers configuration file tracks the usernames of developers with forks that are actively working with the upstream repository.

Format

For GitHub projects, the file is formatted as follows:

userName1
userName2
...

For GitLab projects, the file is formatted as follows:

userName1 forkProjectId1
userName2 forkProjectId2
...

GitLab requires the numerical project ID for certain functions, for example, to generate the appropriate URL for an MR. The project ID is unique to each developer's fork and can be found by going to the homepage of a project and looking for the ID right under the project name at the top of the page.

Related Commands

The Fork Developers config enables the following commands:

  • ghLFD - List Fork Developers
  • ghNMRFTB - New Merge Request for a Fork Ticket Branch
  • ghNMRFMB - New Merge Request for a Fork Misc Branch