Skip to end of metadata
Go to start of metadata


A GitHub Create File activity creates a new file at a GitHub endpoint and is used as a target in an operation. After configuring a GitHub connection, you can configure as many GitHub activities as you like for each GitHub connection.

Creating a GitHub Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the GitHub connection block to display activities that are available to be used with a GitHub connection:

Connectivity tab

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a GitHub activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring a GitHub Create File Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a GitHub Create File Activity

Follow these steps to configure a GitHub Create File activity:

Step 1: Enter Basic Information

Connectivity tab

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Name: Enter a name to use to identify the GitHub Create File activity. The name must be unique for each create file activity and must not contain forward slashes (/) or colons (:).

  • GitHub Repository Name: Enter the name of the repository where the file is to be created.

  • File Path of File to Be Created: Enter a valid name with path (for example, path/file.txt). The path should point to an existing directory on the GitHub server. If no path is entered, the file will be created at the root of the repository.

  • Commit Message: Enter a commit message to identify this commit for creating the file in the repository. The commit message should be unique for each Create File activity.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2: Review the Data Schemas

Connectivity tab

  • Data Schema: The request and response data schemas for GitHub will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The GitHub connector uses the GitHub REST API v3. Refer to the API documentation for information on the schema fields.

    These are the schema fields visible in the example screenshot above:

    • Request:

      Request Schema Field/NodeNotes
      createFileRequestNode of the create file request
      contentRequest content
    • Response:

      Response Schema Field/NodeNotes
      createFileResponseNode of the create file response
      repoNameThe file repository name
      filePathThe file path
      fileShaThe file checksum hash
      commitMessageReturned commit message
      errorMessageReturned error message
  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring a GitHub Create File activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

GitHub Create File activities can be used as a target with these operation patterns:

Other patterns are not valid using GitHub Create File activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a GitHub Create activity in the Two-Transformation Pattern. In this example, the first transformation (Create File Request) creates a request structure that is passed to the GitHub Create File activity. The second transformation (Create File Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Create File Response) and a message is then logged by the Write to Operation Log script:

GitHub Create File Activity

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Feb 23, 2021

  • No labels