Changelog

This changelog is the source of truth for all changes to the Forge platform that affect people developing Forge apps.

Notifications are sent in the #release-notes channel in the Forge Slack workspace when the changelog is updated. To join the Slack workspace, follow the link in the email accepting you into the Forge beta.

27 May 2020

added New IssueAction component for new Jira issue action module in Forge UI version 0.4.0

Check out an example of IssueAction and see Jira issue action for more details.

updated Lozenge component renamed to StatusLozenge

We’ve renamed the Lozenge component to StatusLozenge, to make it distinct from the DateLozenge component.

Run npm install @forge/ui@latest on the command line to install the latest version of @forge/ui.

26 May 2020

notice - deprecation Forge API

storage methods in versions 0.1.7 or less

All versions of @forge/api at less than or equal to version 0.1.7 are deprecated. Only versions greater than '0.1.7' are supported. If your package is not updated, all api.store methods will be unavailable in future deployments.

Run npm install @forge/api@latest in your app directory on the command line to update to the latest version.

bug fixes CLI version 0.14.0

This release includes:

• A fix that enables api.fetch to follow HTTP 303 redirects.
• A fix that enables type validation for Typescript apps on bundle time.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

14 May 2020

added Confluence context menu and content action modules

Confluence Cloud now supports the following new modules:

• Context menu: Display an app in the context menu when a user highlights text. The gif above shows an example app that gives the definition of the selected word.
• Content action: Display an app in the more actions (…) menu. The gif above shows an example app that gives information about the page.

11 May 2020

updated Uninstall command in Forge CLI version 0.13.0

The uninstall command in the Forge CLI now makes it easier to select and uninstall your app from multiple locations. The command first displays a table of locations where the app is installed. Navigate the table with the arrow keys, then select one or more locations to uninstall the app from. Finally, the command reports the result of each uninstall.

Note, the command still supports specifying the location by installation ID for backwards compatibility.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

28 Apr 2020

bug fixes CLI version 0.12.0

This release includes:

• A fix for an error that occurs when tunnelling with a handler file inside a subdirectory.
• A fix that enables the tunnel command to log all variable types.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

7 Apr 2020

added New documentation for Forge security

The Forge documentation now has a Security page. This page describes how the architecture, features, and policies of the Forge platform help make it secure. Note that this page is a conceptual overview and does not provide instructions for implementing security for your app.

30 Mar 2020

added Getting started tutorial for Jira

The documentation now contains a getting started tutorial for Jira. The tutorial takes you through adding a panel to a Jira issue to display the number of comments on the issue. Note, we've kept the Confluence getting started tutorial as well.

See Build a Jira hello world app to work through the tutorial.

added CLI support for a storage API in version 0.11.0

The api object now includes a store component that lets you persist data between invocations of your app. For example, in the app code, you can use:

1
2
3
4

import api from '@forge/api';

await api.store.onConfluencePage('id').set('my-key', 'my-value');
const value = await api.store.onConfluencePage('id').get('my-key');

See Store API for more information.

Note, you need to have the latest version of @forge/api to use the storage API. To update, run npm install @forge/api@latest on the command line.

added CLI support for FS module in version 0.11.0

Forge now supports the fs module. For example, in the app code, you can use:

1
2
3
4

import * as fs from 'fs';

fs.writeFileSync('./file.txt', 'Hello World');
const content = fs.readFileSync('./file.txt', { encoding: 'utf8' }); // content is 'Hello World'

Note, filesystem read/writes are in-memory and do not persist between invocations of the app.

added CLI support for HTTP module in version 0.11.0

Forge now supports the http module. This provides better support for SDKs that use axios or node-fetch.

bug fixes CLI version 0.11.0

This release includes:

• Better support for error messages when using console.error.
• Improved messaging for errors in system credential managers.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

27 Mar 2020

added New templates in the CLI

There are new templates available when running the forge create command in the CLI. We've also updated the names of the existing templates to align with the corresponding modules. Use these to hit the ground running when creating a new app.

Template list:

• blank
• confluence-macro
• confluence-macro-typescript
• jira-issue-glance
• jira-issue-panel
• jira-workflow-validator
• webtrigger

26 Mar 2020

added Tutorial for Jira workflow validator

The Forge documentation now has a tutorial for building a Jira workflow validator. This tutorial gives step-by-step instructions for building a Forge app that validates whether an issue is assigned when it transitions.

18 Mar 2020

added Forge UI adds IssueGlance and IssuePanel for Jira extension points in version 0.3.0

New documentation and examples for extending Jira with IssueGlance and IssuePanel components. See IssueGlance and IssuePanel in the UI components reference documentation for further details.

added Forge UI introduces Lozenge and DateLozenge components in version 0.3.0

Lozenge and DateLozenge are the first inline components we're shipping. We have updated the Text component to accept strings and inline components as children.

1
2
3
4
5
6

const App = () => (
  <Text>
    From <DateLozenge value={Date.now()} /> you can put text, inline components or
    **supported markdown** in here! <Lozenge text="wow" appearance="success" />
  </Text>
);

added Forge UI adds Avatar, AvatarStack, and ModalDialog in version 0.3.0

Avatar and AvatarStack support the existing UserPicker component to make working with users easier.

Use the ModalDialog component to prompt users to perform short-term tasks in your app.

Run npm install @forge/ui@latest on the command line to install the latest version of @forge/ui.

16 Mar 2020

updated Improved tunnel performance in version 0.10.0

Your app code will now reload faster when using the forge tunnel command. We've also updated the messages to notify you when the code starts and finishes reloading.

updated Create app uses dynamic values in version 0.10.0

Some manifest fields are now based on your app's name rather than the static value in the template when creating an app. The supported fields are key and title for macros, and key for web triggers.

bug fixes CLI version 0.10.0

This release includes:

• Further improvements to error messages in the CLI.
• Better formatting and error handling when using console.log with JSON in the app runtime.
• Reduced idle CPU usage.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

11 Mar 2020

added Jira workflow validator, issue panel, and issue glance modules

The first Jira modules are available to try in Jira Cloud.

• Workflow validators: Create validators that apply to workflow transitions.
• Issue glances: Show a Forge app in the sidebar of Jira issues in the new issue view.
• Issue panels: Show a Forge app above the activity panel of Jira issues in the new issue view.

3 Mar 2020

added CLI uses Docker to reduce the prerequisites in version 0.9.0

The Forge CLI no longer requires special tooling for Windows, Python, or libsecret. The Node.js requirement has also loosened to version 10.0.0 or later. Most of these were required for the forge tunnel command. Instead, the CLI uses a Docker image to manage these dependencies. These changes also decrease the package size, improving the install time.

Note, you need Docker to run the forge tunnel command.

added CLI supports ArrayBuffer responses in version 0.9.0

The Forge CLI now fetches ArrayBuffer responses. For example, in the app code you can use:

1
2

const response = await api.fetch('https://www.atlassian.com/');
const arrayBuffer = await response.arrayBuffer();

bug fixes CLI version 0.9.0

This release includes:

• Forge API now exports methods according to the ES module standard. You can now import individual methods as well as the default api export.
• Users without keytar no longer need to use environment variables to log in.
• Improvements from UX feedback, including improved error messages.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

28 Feb 2020

added New documentation for Forge debugging

The Forge documentation now has a debugging page. This page lists common errors that you may see when developing a Forge app. It also describes the Forge tools that are available to diagnose errors during debugging, such as logging and tunneling.

24 Feb 2020

added New documentation for Forge UI

The Forge documentation now has a Forge UI page. This page describes the main Forge UI concepts: components, hooks, and event handlers. Note that the existing Forge UI hooks page has been removed in favor of this new page.

18 Feb 2020

added Forge UI supports macro configuration in version 0.2.0

Users can now configure each instance of a Forge macro. Use the new ConfigForm and Macro components along with the useConfig hook to add configuration to your macro.

See Add configuration to a macro for instructions on adding configuration to a macro.

added Forge UI adds UserPicker component in version 0.2.0

A form component that provides a dropdown control populated with users, enabling one to select a user on the site.

Run npm install @forge/ui@latest on the command line to install the latest version of @forge/ui.

3 Feb 2020

added CLI supports custom filenames for function handlers in version 0.8.0

The Forge CLI now enables you to use custom filenames for the handlers in the manifest.yml file. For example, you can use:

1

handler: myFile.myFunction

See the manifest entry in the reference section for more details.

added CLI create command installs dependencies in version 0.8.0

The Forge CLI now installs the required dependencies when you create an app. This means you no longer need to run npm install after running forge create.

bug fixes CLI version 0.8.0

This release includes:

• A fix to stop the tunnel closing when running the forge tunnel command.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

20 Jan 2020

added CLI update notifier in version 0.7.1

The Forge CLI update notifier checks whether the CLI is up to date with the most recently released version. If your CLI version is behind, the CLI prompts you to update. We recommend keeping the CLI up to date to have the latest features and bug fixes.

bug fixes CLI version 0.7.1

This release includes:

• A fix for the compatibility issues with Node 13. We recommend you continue using Node 12 to develop on Forge because it is the long-term supported version of Node.
• Performance improvements.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

10 Jan 2020

notice - change Forge logs

On 13 January 2020, we'll deploy a new logging persistence layer to Forge. We are making this change to improve our ability to provide fast and reliable logging for larger numbers of apps. This is an internal infrastructure deployment that does not add, remove, or change any of the functionality available in Forge.

When we deploy this change, any messages logged before that point will no longer be visible when you run the forge logs command in the Forge CLI.

6 Jan 2020

bug fixes CLI version 0.6.2

This release includes:

• Fix for installation issues on the Windows platform.

Run npm install -g @forge/cli@latest on the command line to install the latest CLI version.

2 Jan 2020

added Example apps

See example apps for a list of open-source Forge apps. Use the apps as examples of what you can build with Forge. Explore them by reading the code, cloning the repo, and deploying the apps yourself.

9 Dec 2019

added Changelog

This changelog is the source of truth for all changes to the Forge platform that affect people developing Forge apps.

The changelog includes:

• Notices of upcoming change or deprecation.
• Feature additions, removals, and updates.
• Bugfixes.