Updates & Notifications

Release announcements, the What's new popup, plugin update balloons, notifications from the Intellij SFCC team and error reports

Intellij SFCC tells you about new releases in three ways: a What’s new card when a release is published, a balloon when the IDE can install the update, and the release history under More › All Release Notes. Notices from the Intellij SFCC team and error reports use the same IDE notifications. None of this needs an account or a license

A new release shows its What’s new card once and the update check offers to install it. More › All Release Notes opens the release history at any time

Release announcements

The plugin reads the public Intellij SFCC release catalog 5 seconds after the IDE starts and then every 5 minutes. When it finds a release you haven't seen yet, it shows two things:

  • The What’s new in version card in the middle of the IDE window, under the line JetBrains · New release · Installed your version and the release date
  • A balloon, Intellij SFCC version is available, with "See what's new. You have your version installed"

The card lists the release's resources. Release notes is always there ("Features, improvements and fixes in" version, with its address), and each blog post of the release gets a Blog post entry. Every entry has two buttons:

ButtonWhat it does
Open in BrowserOpens the page in your default browser, even when the IDE has another browser set for development
Open in IDEOpens the page in an IDE tab, see Pages in an IDE tab. Disabled with "IDE preview is unavailable. Use Open in Browser." when the IDE has no embedded browser

Click Dismiss or press Esc to close the card. Dismissing it, or opening one of its pages, marks the release as seen, so it isn't announced again. The card stays open when you click elsewhere in the IDE, and if it closes any other way, for example with the project, it comes back later

A few rules decide when the card appears:

  • Only the newest published release is announced, never an older one
  • The card waits while you work in another application or the project is still opening, and shows when you come back to the IDE window. It doesn't take the keyboard focus from the editor
  • On a fresh install, the card shows the release notes of your installed version once, with JetBrains · Your installed version and the balloon Intellij SFCC version release notes
  • If the catalog can't be reached, nothing is shown and the plugin tries again 5 minutes later

The balloon stays in the IDE's Notifications tool window after it closes, so you can come back to it:

Balloon actionWhat it does
View releaseOpens the What’s new card again
Release notes in BrowserOpens the release notes in your browser
Blog post in BrowserOpens the release's blog post, when it has one
JetBrains MarketplaceOpens the plugin's page on JetBrains Marketplace, shown only for a newer release

After an update

The first time the IDE starts with a newer Intellij SFCC version, the plugin opens what's new in that version in an IDE tab: the release's blog post, or its release notes when it has no post. This happens once per version, and the What’s new card isn't shown for the same release. Without the IDE's embedded browser, the page opens in your default browser instead

Release history

Open More › Plugin › All Release Notes to see every release in the What's new in Intellij SFCC dialog. The dialog opens with your installed release selected

The Releases list on the left shows each release, newest first, with its date. A newer release than yours is tagged New, and yours is tagged Installed. Your installed release is always in the list, even before the catalog loads or when you're offline

ControlWhat it does
Refresh button next to ReleasesLoads the release history again ("Refresh release history")
Load older releasesShown at the end of the list when the catalog has more releases
All release notesOpens every Intellij SFCC release in your default browser
Double-click or Enter on a releaseOpens its release notes, the same as Read release notes
Close or EscCloses the dialog

The right side shows the selected release: its version with an Update available or Installed badge, the line "Released" date, and "You have" your version for a newer release

ButtonWhat it does
Preview announcementShows the What’s new card for this release ("Show the release popup for" version)
Update Intellij SFCCShown for a newer release. Closes the dialog and opens Settings › Plugins, where you install the update
Read release notesOpens the release notes in an IDE tab. Without the IDE's embedded browser, it opens them in your browser
Open in BrowserOpens the release notes in your default browser
Read under From the blogOpens a blog post of the release, in an IDE tab or with the arrow button in your browser

The line at the bottom tells you where you stand:

StatusMeaning
"Checking published releases…"The catalog is loading
Intellij SFCC version is availableA newer release is published
"You're on the latest release"You have the newest release
"No published releases yet. Showing notes for your installed version."The catalog is empty, the list shows your installed version only
"Couldn't reach the release catalog. Installed notes are still available."The catalog didn't answer. Click Retry or the refresh button

Pages in an IDE tab

Open in IDE, Read release notes and some notice links open the page in an editor tab with the IDE's embedded browser. The bar above the page shows its address in a read-only field, and Open in Browser opens the current page in your default browser. Opening the same address again brings its tab to the front instead of opening a second one, and a link that the page opens in a new window gets a tab of its own

If your default browser can't be started, the plugin shows Couldn't open your browser with "Open the release again from All Release Notes, or copy the address from the IDE tab."

Plugin updates

While a project is open, the plugin asks the IDE every 3 hours whether a newer Intellij SFCC version is available on JetBrains Marketplace. The first check runs 3 hours after the project opens. When there is one, you get the balloon Intellij SFCC update available: "Please click on the link below to update the plugin to the latest version"

Click Install version version. The background task Installing Intellij SFCC version version runs the IDE's plugin update, and the IDE shows the result as it does for any plugin update

You can also update from Settings › Plugins at any time, or with Update Intellij SFCC in the release history

Notices from the Intellij SFCC team

The Intellij SFCC team can post a short notice to the IDE. It arrives as an information, warning or error balloon in the INTELLIJSFCC group:

  • A notice can have up to three links. Each link opens in your default browser or in an IDE tab, as the notice sets it
  • A notice waits until an IDE window is active, so it doesn't appear while you're in another application
  • Each notice is shown once, and stays in the Notifications tool window after the balloon closes

Error reports

When the plugin hits an unexpected error, the IDE shows it in its error indicator in the status bar. Open the error from there and submit it: Intellij SFCC sends error reports through JetBrains Marketplace, so they reach the plugin's developers with the stack trace

To describe a problem in your own words, use More › Plugin › Report Bug, see Actions & Shortcuts

Turn balloons off

Every balloon on this page belongs to the INTELLIJSFCC notification group. Open Settings › Appearance & Behavior › Notifications, find INTELLIJSFCC and choose how it shows, for example No popup. The messages still go to the Notifications tool window. The What’s new card isn't a balloon: click Dismiss and it doesn't come back for that release

Troubleshooting

SymptomWhat to do
The What’s new card doesn't appear for a new releaseBring the IDE window to the front, the card waits for an active window. The catalog is read every 5 minutes, so a release can take a few minutes to show. You can always open it from More › All Release Notes › Preview announcement
The card comes back for the same releaseClose it with Dismiss or Esc. A card closed any other way counts as not seen
Open in IDE is disabled, or pages open in the browserThe IDE runs without its embedded browser (JCEF). Use Open in Browser
"Couldn't reach the release catalog. Installed notes are still available."Check your connection or proxy, then click Retry. The notes of your installed version still open
Couldn't open your browserOpen the page in an IDE tab and copy the address from the bar above it
No Intellij SFCC update available balloon although a newer version is outThe check runs every 3 hours while a project is open. Update from Settings › Plugins or with Update Intellij SFCC in the release history
Too many balloonsChange the INTELLIJSFCC group in Settings › Appearance & Behavior › Notifications

On this page