Implementation

Integrating a GitHub Account with Catalyst

You can easily integrate and authenticate your GitHub account with Catalyst from the console.

To integrate a GitHub account with Catalyst:

1. Navigate to Amplify > Git.

2. In the GitHub Integration page, click Integrate GitHub.
   
   

3. In the Terms of Use and Privacy Policy pop-up window, click Agree after reading the terms of use and privacy policy statements.
   

You will be redirected to GitHub’s authentication page.

4. In the GitHub Authentication page, enter your Username or Email address and password.
   

5. Click Sign in.

6. In the Authorize Zoho Catalyst window, click Authroize ZohoGadgets for the permissions requested.
   
   Once the authorization is complete, you will be redirected back to the Catalyst console.

If the authentication is successful, your GitHub repositories will be displayed in the GitHub Integration page.

You can also integrate your GitHub account with Catalyst from the Git Integration settings in the same manner:

1. Navigate to Settings > Integrations.

2. In the Integrations section, click GitHub.

3. In the GitHub Authentication section, Click Integrate GitHub.
   

4. Follow the same steps as above to integrate your GitHub account with Catalyst.

The GitHub Integration page lists your Git repositories and displays the Repo Name, Repo URL, and Default Branch.

Only the branch of your repository which is marked as ‘Default’ in GitHub will be displayed here. Usually, the master branch is considered the default branch of your Git repository. You can find more information about GitHub branches in the GitHub help documentation.

Deploying a GitHub repository from Catalyst

As discussed in the introduction, before deploying a Git repository from Catalyst, you should make sure that the repository contains the resources in the standard project directory format. Ensure that the catalyst.json file is present in the GitHub repository for a successful deployment.

To deploy a Git repository from Catalyst:

1. Navigate to Amplify > Git.
2. In the GitHub Integration page, click on the name of the repository that needs to be deployed using the radio button.
   
   
3. Click Deploy.
4. In the confirmation window, click Deploy again.
   
   

Once the deployment process begins, you will see the progress of the deployment status in the GitHub Integration page. The progress status bar also displays the repository name and the repository URL.

When the deployment process is complete, you will receive a notification stating whether the deployment was successful or unsuccessful. If your deployment was successful, you will be able to see the status in the Deployed repository status bar, along with the repository name and URL.

When a repository is deployed successfully, your Catalyst project will be updated in the following ways:

• The functions in the Functions folder in your Git repository will be available in the Functions page in the Catalyst console. To verify them, navigate to Develop > Functions. You can view all the functions in the default branch of your repository in the Functions page.
• The client package in the Client folder in your Git repository will be automatically hosted in Catalyst. If it is a web app, you can view the hosted application in Catalyst by navigating to Hosting & Management > Web App. If it is a mobile app, you can view the hosted application in Catalyst by navigating to Hosting & Management > Device Management. Refer to the Web App and Device Management sections for more information.

Synchronizing changes in GitHub with Catalyst

Catalyst console allows you to easily synchronize the changes made in your deployed GitHub repository. When you update the files in the repository in GitHub, the changes will be reflected in Catalyst as well.

To synchronize the changes made in your deployed GitHub repository to Catalyst:

1. Navigate to Amplify > GitHub.
2. In the GitHub Integration page, click Sync on the Deployed Repository status bar.
   
   

The Deployed Repository status bar will display the synchronization progress state. Once the synchronization process is complete, you will be able to view the latest updates to your repository in your Catalyst console.

Revoking Access to GitHub from Catalyst

You can easily revoke access for GitHub to Catalyst and remove the GitHub integration for the account. You can also use this option to integrate a different GitHub account with Catalyst.

To revoke access to GitHub from Catalyst:

1. Navigate to Settings > Integrations
2. In the Integrations section, click GitHub.
3. In the GitHub section, click Revoke.
   
   
4. In the Revoke Access confirmation window, click Revoke again.
   
   The Revoke Access confirmation window informs whether the repository is being actively used by any integrations or not.

The access to the GitHub account will be revoked from Catalyst. Once the access is revoked, you will no longer be able to view your Git repositories in the GitHub Integration page.