Apps

All our apps are handled via the deployment cycle. This means updates traditonally are only applied on the first of each month.

Creating a new app

Creating a new app is a more involved process. For this, you will:

1. Setup the project (see the project setup workflow for more details)
2. Install the app in the sandbox Zendesk
3. Install the app in the production Zendesk
4. Setup the scheduled pipeline for the project

Updating an app

Updating an app is done by updating the source code of the app.

You should also do this in a way that creates a MR. Said MR should always be peer reviewed before merging (the MR should enforce this).

Deactivating an app

Deactivating an app requires a very manual process. When deactivating an app, you must:

1. Deactivate the app in the Zendesk instance
   1. Navigate to the Zendesk instance’s admin center
   2. Navigate to Apps and integrations > Apps > Zendesk Support apps
   3. Hover over the app in question
   4. Click the gear icon
   5. Click the slider under Enabled
2. Deactivate the scheduled pipeline for the app
   1. Navigate to the app project
   2. Go to its scheduled pipelines
   3. Click the button to assume ownership of the scheduled pipeline
   4. Click the icon to edit it
   5. Uncheck the box next to Activated
   6. Click Save Changes

Packaging an app

This is done by combining all the “app code” into a zipfile. To accomplish this, you need to access the app project’s source code via CLI and zip the content up. This might look something like:

cd ~/dev/support-readiness/zendesk-global/apps/star
zip -r data/application.zip assets manifest.json translations

This will produce the zipfile application.zip in the data folder of your local repository (which git will ignore thanks to the .gitignore file you copied earlier).

Exception deployment

Some changes, such as bug fixes, warrant an immediate deployment.

To perform an exception deployment for an app, navigate to the app project in question, go to the scheduled pipelines page, and click the play button. This will trigger a sync job for the app.

View page source - Edit this page - please contribute.