ContextQMD
Back to Sst

Update Permalinks

www/src/content/docs/blog/update-permalinks.mdx

4.13.12.4 KB
Original Source

import { Image } from "astro:assets"

import updatesLight from '../../../assets/blog/sst-console-updates-light.png'; import updatesDark from '../../../assets/blog/sst-console-updates-dark.png';

Moving forward, every update made to an SST v3 app will get a unique URL; a permalink. This is printed out by the SST CLI.

bash
↗  Permalink   https://sst.dev/u/318d3879

These permalinks redirect to a page in the Console. Check out a short video of this in action.

<picture> <source srcset={updatesDark.src} media="(prefers-color-scheme: dark)" /> <source srcset={updatesLight.src} media="(prefers-color-scheme: light)" /> <Image src={updatesLight} alt="SST Console Updates" /> </picture>

Here you can view:

  1. Full list of all the resources that were modified
  2. Changes in their inputs and outputs
  3. Any Docker or site builds logs
  4. CLI command that triggered the update
  5. Git commit, if it was an auto-deploy

You'll need to have your AWS account connected to the Console to view these details.

How it helps

The permalinks are useful for.

  1. Debugging deploys: The changes in the inputs of a resource let you see if the changes to your sst.config.ts have been applied correctly.
  2. Speeding up deploys: You can check which resources are taking long. Or why a certain resource is being updated in the first place.
  3. Sharing with your team: Say you run into an error while running sst dev locally; now you can send this link to a teammate. And they can view the full event log instead of asking you to send them the log file from your local machine.

How it works

In addition to the state updates, the SST CLI also uploads the event log from every update to the S3 state bucket in your AWS account. It also generates a globally unique id for the update.

If your AWS account is connected to the Console, it pulls this state and generates the details for the update permalink. This also means that the Console can only show you updates after your AWS account has been connected.

When you visit the permalink, the Console looks up the id of the update and redirects you to the right app in your workspace.

You can learn more about updates in the Console and how state works over on the docs.