Rate this page:

Manifest

The manifest file describes your Forge app. It’s created as part of the Forge CLI’s forge create command with filename manifest.yml. The manifest uses YAML syntax.

Properties

The manifest contains the following top-level properties: app, modules, permissions, and resources (optional).

Note that the optional runtime configuration is nested under the app key.

PropertyRequiredDescription
appYes

Identifying information about the app.

See App to learn more.

modulesYes

A list of the modules used by the app.

See Modules to learn more.

permissionsYes

A list of the permissions required by the app.

See Permissions to learn more.

resources

A list of the resources used by the app.

See Resources to learn more.

App

The app dictionary contains details about your Forge app. These are populated as part of the forge create command.

PropertyRequiredDescription
idYesA unique Atlassian resource identifier (ari) assigned to your app.
nameYesThe app's name. Maximum 50 characters.

Example

1
2
3
app:
  id: "ari:cloud:ecosystem::app/406d303d-0393-4ec4-ad7c-1435be94583a"
  name: my-cool-forge-app

Runtime

Each time you deploy or invoke code on Forge, your code runs inside the sandbox environment. The runtime properties allow you to configure aspects of your app's environment.

PropertyTypeRequiredDescription
snapshots

boolean

Whether a snapshot of the app is taken at deployment time. Default value of true.

Example

1
2
3
app:
  runtime:
    snapshots: true

Rate this page: