...

One of Kajoo’s most exciting convenient features is the ability to publish components projects directly to a GitHub repository. The publishing process has multiple configuration options, and can even be configured for CI/CD.

Site Configuration

To publish to a GitHub repository, you first need to create a site profile in the Sites setting of Kajoo. You will need the repo’s URL, and it’s recommended that you create a branch specifically to Kajoo to push to.

...

Adding a New Site

To add a GitHub repo to your site settings, follow the following instructions.

1. Click the “Add New” site button

2. In the right-hand pane that pops up, enter a name and URL for the site. The URL does not need to be the GitHub URL, and is not important for the publishing process

3. Under the “Source Control Integration” heading, click the GitHub button. This should pop up a window that will allow you to sign into your GitHub account through Kajoo.

4. Once Kajoo is connected to your GitHub account, you can select from among your repos, and among the branches on that repo. Choose a branch that you wish Kajoo to push to. You may want to make a new branch just in case.

5. Go ahead and save. Now you have your site setting saved and ready for publishing.

   Image Removed

Publishing to your GitHub Repo

After setting up the Site configuration settings, publishing is easy from the Kajoo Builder.

1. In the Builder, click the “Publish” button on the top right corner of the screen.

2. A popup will appear that asks you to select among the Sites created in the Site configuration page.

3. After selecting a Site from the dropdown menu, simply click “publish” to push to your repo

   Image Removed

You should then be able to see the commit in your GitHub repo:

...

repo, multiple Sitecore instances, and directly to the head if desired.

Prerequisites

In order to publish a Kajoo project to a Github repo, a Sitecore instance and/or to a head, you must already have registered your Sitecore instances with Kajoo and configured site settings. Please refer to our documentation on Connecting Kajoo to Sitecore to set up the proper configurations, and let us know if you have any trouble!

Publishing

After setting up the Site configuration settings, publishing is easy from the Kajoo Builder.

...

1. In the Builder, click the “Publish” button on the top right corner of the screen.

2. A modal will pop up that shows three options: Check-In, Download, and Deploy

Check-In

To check in code to a GitHub repo, you need to have a Site configured with a connected GitHub account (see Connecting Kajoo to Sitecore).

1. Select “CheckIn” in the Step 1 Publishing options

2. In Step 2, choose the site configured with the desired GitHub repo and branch

   Image Added

3. In Step 3, click “Publish”. Your generated code should be checked into the GitHub repo and branch set up in your Site Configuration.
   

   Image Added

Download

You can choose to simply download your generated code from your Kajoo project. This option does not require Site Configuration, setting up a GitHub repository, or connecting a Sitecore Instance.

1. In Step 1 on the Publishing Options Modal, choose “Download”.

2. In Step 2, simply press “Publish”.
   

   Image Added

3. In Step 3, press the “Download” button. You will download your generated React/JSS code in a zip file.
   

   Image Added

Deployment to Site

You can choose to deploy your Kajoo project to a configured site (see Connecting Kajoo to Sitecore). If you have not yet configured a site, please refer to that documentation, as Site Configuration includes all important deployment configuration, including registering Sitecore instances with Kajoo, connecting GitHub, and selecting Head deployment options, if any.

1. To deploy to a configured site, select the “Deploy” option in step 1 of the Publishing Options modal.

2. In Step 2, select among configured sites to deploy to:
   

   Image Added

3. In Step 3, select among the Environments attached to your configured site (eg. QA, UAT, Prod, etc). The environment selection determines which Sitecore instance(s) your code will be deployed to.
   

   Image Added

4. In Step 4, click “Publish.” Your code should be generated, pushed to your GitHub repo, built, then pushed to your Sitecore instance(s) of choice. Depending on your site configuration, it may also be deployed to your site’s head through FTP or SSH.
   

   Image Added

Related articles