› Packages › Add a package to GitHub

Add a package to GitHub

You can add the package definition and its contents to GitHub. You can do this only if you have configured GitHub integration. See Configure GitHub integration.

  1. Navigate to Packages > Packages.
    The Packages page appears.
  2. Do either of the following:

    Add an existing package to GitHub

    1. On the Packages page, on the context menu of the package to add to the GitHub, click Add to GitHub.

      The Add package to GitHub dialog box is displayed.

    2. Enter the comments for the package in the Comment field.

    3. When you add a package to GitHub, by default, a new folder with the same name as the package is created and added to GitHub. If the folder with the same name already exists in GitHub, a warning message appears that the folder name already exists. You must choose a different package name.

      Optional. To set this folder as your working folder, select the Set as working folder check box. Otherwise, the working folder that is created in the GitHub repository is used as the working folder.

      The working folder set here is displayed on the "GitHub working folder" list while editing the user profile or setting the properties of an individual resource.

    4. Click Add to GitHub.

      The Packages page appears.

    Add the package to GitHub directly when creating a new package

    1. On the Packages list page, click New.

      A package opens in a new browser tab.

    2. Enter a Name and Description for the package.

      The package name cannot contain special characters.

    3. Set the other properties of the package as needed.

    4. To quickly add items to a package, on the Add list, select the most commonly used item, such as, Processes, Cases or Custom services, or click a group to expand, such as User interface and select specific item type, such as Forms.

    5. On the package modeling bar, click Add to GitHub.

      The package is saved, closed and unlocked, and appears on the Packages page.

    The package definition is added to the GitHub and checked in. Simultaneously, the package is added to the TotalAgility repository in your local system at the following location:\\ProgramData\Kofax\TotalAgility\GIT\<gitsample>\<packagename>.

    Where, <gitsample> is the folder name you specified for the GitHub repository when configuring the GitHub integration.

    A source control indicator appears adjacent to the package name indicating that the package definition is added to the GitHub and checked in. Any child packages and non-versioned items in the package are ignored and not added to GitHub. For a shared classification group that is added to GitHub as part of package, the source control indicator appears as read-only; it does not appear for a classification group.

    When adding a package to GitHub, the document and activity variants are added to GitHub as part of the extraction group, form variants as part of the form and skins as part of the process. The variants and skins are not marked as being in GitHub within the Designer.

    From the context menu options of the package that is added to GitHub, you can check out, check in, and get the latest version of the package.

    The file size to check in to GitHub cannot exceed 100 MB.

How to: