Page Summary

outlined_flag

• Apps Script project deployments make script versions available for use as web apps, add-ons, or API executables.

• There are two types of deployments: Head deployments, which are always synced to the current project code and used for testing, and Versioned deployments, which are connected to a specific project version and used for public consumption.

• You can create, view, edit, and find the ID of versioned deployments through the Deploy > Manage deployments menu in your Apps Script project.

• You can test deployments differently depending on the type of app you build, with specific instructions for Google Workspace add-ons, Editor add-ons, web apps, Google Chat apps, and API Executables.

• Versioned deployments cannot be deleted but can be archived and redeployed through the Deploy > Manage deployments menu.

An Apps Script project deployment is a version of the script that is madeavailable for use as a web app, add-on, or API executable. By creating andmanaging deployments, you can iterate on your code, keep track of your changes,and control the exact code version your users have access to.

There are two types of deployments:

• Head deployments, which are always synced to the current project code.
• Versioned deployments, which are connected to a specific project version.

Head deployments

A head deployment is the current project code. When you create an Apps Scriptproject, you automatically create a head deployment for that project.

The head deployment is always in sync with most recently saved code. Forexample, if you create a versioned deployment and then modify your code, thehead deployment reflects those changes, while the versioned deployment remainsintact.

Use head deployments to test code. Don't use head deployments for public use.

To deploy a version of a Google Workspace add-on,Editor add-on, Google Chat app, or an APIexecutable, you must firstswitch your Apps Script’sGoogle Cloud project association from the default project to a standardproject.

To create a versioned deployment, follow these steps:

1. Open the Apps Script project.
2. At the top right, clickDeploy>New deployment.
3. Next toSelect type click Enable deployment typessettings.
4. Select the deployment type that you want to deploy. For Google Workspace add-ons, Editor add-ons, and Google Chat apps, selectAdd-on.

5. Enter the information about your deployment and clickDeploy.

   Note: Each new deployment can be shared as a library. If you share the scriptas a library, the deployment description is visible to users of the library.

View versioned deployments

To view the deployments of an Apps Script project, at the top, clickDeploy>Manage deployments.

To view the code of a specific version, refer toView a previous version.

Edit a versioned deployment

You can edit a versioned deployment to change its description or version. Toedit a deployment, follow these steps:

1. Open the Apps Script project.
2. ClickDeploy>Manage deployments.
3. Select the active deployment you want to change and click Editedit.

4. Make your changes and clickDeploy.

   If you want to edit an archived deployment, you must redeploy it, thenfollow the preceding steps.

   When you want to deploy a change to the project code, create a new version andedit the deployment to use it. The new version is automatically used by anyusers that use that deployment.

Find a deployment ID

Every deployment has an associated string ID automatically created for it. Tofind this ID, follow the steps below:

1. Open the Apps Script project.
2. At the top right, clickDeploy>Manage deployments.

3. Select an active deployment to find its ID.

   Deployment IDs only appear on active deployments.

Test a deployment

How you test a deployment depends on the type of app you build.

Archive a versioned deployment

You can't delete versioned deployments. Instead, you can archive them.

To archive a versioned deployment:

1. Open the Apps Script project.
2. ClickDeploy>Manage deployments.
3. Select the deployment you want to archive and click Archive deploymentarchive.

Redeploy an archived deployment

1. Open the Apps Script project.
2. At the top right, clickDeploy>Manage deployments.
3. At the left underArchived, select the deployment you want to redeploy and click Editedit>Deploy.