Version 5.0 Migration Guide

GitHelp underwent breaking changes with the release of version 5.0. This guide details those changes and how to migrate existing projects originally configured using version 4.2.0 or lower to take advantages of the features in version 5.0.0 and later.

Version 5.0 Changes

GitHelp was originally developed assuming the use of Jira for managing tickets. Many commands and scripts were named using 'J' or 'Jira' to refer to branches that were associated with a particular Jira ticket or epic.

With version 5.0 of GitHelp, the use of Jira is no longer an assumption. Instead, when cloning a project, users can specify the ticket source (ClickUp, GitHub, GitLab, or Jira) being used along with a base URL for those tickets. Instead of branches being 'Jira Branches', they are now 'Ticket Branches'. To coincide with the change in terminology, the script names and aliases have changed. The GitHelp project configuration has also changed meaning version 5.0 of GitHelp will not work with projects configured using an earlier version of GitHelp unless the following migration steps are completed.

Project Configuration Migration

1. Open ~/.gitHelp_profile_list in an editor to view all your projects with a GitHelp configuration. You should see something like the following:

printf "GitHelp Configurations:\n"

printf "   https://github.com/myusername/GitHelp  myusername  /Users/myuserdirectory/REPO/GitHelp  NOJIRA  development \n"

...

2. Delete any configurations for stale projects you aren't using anymore.
3. (Optional) Replace NOJIRA with NOTICKET.
4. Between the GIT_ROOT (/Users/myuserdirectory/REPO/GitHelp) and the TICKET_PREFIX (NOJIRA) values, insert the values for the TICKET_SOURCE (any of the following: 'ClickUp', 'GitHub', 'GitLab', or 'Jira') and for the TICKET_BASE_URL (the URL with a trailing '/' to which a ticket ID is appended to access a particular ticket, example: https://github.com/SiliconValleyOffice/GitHelp/issues/). Do this for each project configuration in ~/.gitHelp_profile_list and save the file. The result should look something like the following:

printf "GitHelp Configurations:\n"

printf "   https://github.com/myusername/GitHelp  myusername  /Users/myuserdirectory/REPO/GitHelp  GitHub  https://github.com/SiliconValleyOffice/GitHelp/issues/  NOTICKET  development \n"

...

5. Run ghCR <project name> to update the current configuration of your active project.

Workflow Updates

There are no updates to the workflow with GitHelp 5.0 except that the command aliases have changed. Almost across the board, the change is simply replacing 'J' or 'Jira' in commands with 'T' or 'Ticket'. The only exceptions to this are:

• ghRJT/ghReviewJiraTicket has been renamed ghRT/ghReviewTicket.
• The ghCMTF/ghCommitModifiedTrackedFiles command has been removed.