Modules
Display conditions

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.

connectModules

This functionality is an alpha release.

A list of the connect modules used by the app.

remotes

This functionality is an alpha release.

A list of remote services required by the app.

Currently only used for Connect on Forge apps.

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.
connect

This functionality is an alpha release.

Details specific to Connect on Forge apps.

This is required if the manifest has connectModules.

See Connect to learn more.

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

Connect

This functionality is an alpha release. A Forge app can include Connect modules, and a connect key. This is intended to ease the transition from Connect to Forge. See Build a Connect on Forge app for more information.

PropertyRequiredDescription
keyYes

A key to identify Connect on Forge apps and Forge successors to Connect apps.

key is environment specific. See how to manage environments in the Connect on Forge tutorial.

Note: The production environment of the app must match the Atlassian Marketplace key.

remote

The key of the remotes entry that holds the connect app baseUrl.

This is required if the manifest has connectModules.

Example

1
2
3
4
5
6
7
remotes:
  - key: connect-app-server
    baseUrl: https://hello-world-app.example.com
app:
  connect:
    key: hello-world
    remote: connect-app-server

Rate this page: