ProductFeaturesWork

Release Notes Newsletter

Email stakeholders an AI-curated summary of the user-facing features each release ships, with an optional review step and images.

The release notes newsletter tells people outside your team what changed. Fabric reads the releases in the project's connected repositories, picks the major user-facing features, and writes a short summary for each one. It can send on a schedule or when you click Send now, and it can hold each issue for an admin to check first.

You set it up per project under Settings → Newsletter.

Set it up

  1. Connect at least one repository under Settings → Development. The newsletter reads releases from the project's active repository connections.
  2. Open Settings → Newsletter and add subscribers under Audience. You can paste several email addresses at once, separated by spaces, commas or new lines. Turn on Send to entire organization to add everyone in the organization before each send. People who unsubscribed stay unsubscribed.
  3. Choose the Cadence, Day of week and Send hour (UTC), then turn on Enable newsletter. Without it, the newsletter sends only when you click Send now.
SettingWhat it does
Lookback window (days)The minimum days of history each send covers. Leave it blank to send only what is new since the last send. A value larger than your cadence includes releases that were already announced.
Detail levelHow much each summary says. Standard is the default.
Delivery destinationWhere the newsletter goes. Email sends to subscribers.

If Fabric finds no major features, nobody is emailed and the send history shows why.

Review before sending

Turn on Require review before sending to hold each newsletter until a project admin approves it. When a newsletter is held, reviewers get an in-app notification and an email (when mail is configured). You can also tick Teams or Slack channels under Review alert channels to post the alert there.

Click Review on the held newsletter to open it. In the review dialog you can:

  • untick a highlight to leave it out of the email;
  • drag a highlight to change its order within its release;
  • click Approve & send to deliver it now, or Reject to discard it.

A held newsletter that nobody reviews for 14 days is marked Review expired the next time a send runs, and it is never delivered.

Add images to highlights

Turn on Images in highlights to add up to two images to each highlight. You can upload images yourself in the review dialog, and Fabric can capture screenshots of your product for you.

Click Add image under a highlight and pick a PNG or JPEG file. Files up to 300 KB are used as they are. Your browser scales a larger file down to 1200 px wide and compresses it until it fits, before it uploads.

Click an image to change it:

ControlWhat it does
Include in emailUntick to keep the image with the highlight but leave it out of this email.
DescriptionText shown to readers whose mail app blocks pictures.
Shown underMoves the image to another highlight.
Move earlier, Move laterChanges the order of the images under one highlight.
Not the right screen?Describes the screen again and captures a new screenshot. Shown for captured screenshots only.
Replace, Download, RemoveSwap the file, save a copy, or delete the image.

The Image dialog for a captured screenshot of a Work orders list filtered to high priority: Include in email ticked; a Description field reading "The Work orders list with the new priority filter." with the hint that it is shown to readers whose mail app blocks pictures; Show above the text and Show below the text, with below selected; a Shown under picker set to the highlight "Filter work orders by priority"; Move earlier (disabled) and Move later; a Not the right screen? box with the words to capture again and a Capture again button; and Replace, Download and Remove

The footer counts how many images are included, and the approve button names that number. When you reject a newsletter, its review expires, or it fails or is skipped, Fabric deletes its images. A sent newsletter keeps only the images in the email.

To take the images out of a newsletter that was already sent, click Remove published images on its row in Send & history. The images disappear from the delivered emails and from the release notes archive. This cannot be undone.

Capture screenshots automatically

The Images in highlights setting switched on, with the hint "Add up to two images to each highlight. Choose an environment to capture screenshots automatically." and a Capture from picker set to an environment named "Demo (sample data)"

Under Images in highlights, choose an environment in Capture from. Use an environment that shows sample data only: its screenshots go to everyone who receives the newsletter. Fabric asks you to confirm this when you choose the environment, and production environments are not offered. If someone later changes that environment's address, sign-in page, type or credential, Fabric clears the choice and you confirm again. Environments are set up under Settings → Environments, and Fabric signs in with the credentials saved there. Give it an account of its own that sees only that sample data and has no admin rights: captures never open administration or settings screens, and an account without access to them keeps it that way even if the app changes.

When a newsletter is written, Fabric decides which highlights change something a reader can see, using the files each release changed, the pull requests its notes name, and the work items behind them. For up to eight of those highlights, it opens the environment in a browser, finds the screen that shows the change, and captures it. It only looks: it never clicks anything that saves, sends or deletes data. When it cannot find the screen, it gives up and records why instead of capturing a different one. Before each capture, email addresses and phone numbers on the screen are replaced with placeholders, the name of the account Fabric signed in with becomes "Jane Doe", and profile pictures, cookie banners and floating chat buttons are hidden. Fabric waits for each screen to finish loading before it reads it. A capture shows the panel or section that holds the change rather than the whole page where it can, and is taken at double resolution so its text stays sharp in the email. Screenshots are at most 1200 px wide and kept under 300 KB.

  • With review turned on, captured screenshots appear in the review dialog unticked, so you choose which ones go out. A screenshot that could not be captured shows a short reason instead.
  • With review turned off, captured screenshots are sent in the newsletter without review.

The Review newsletter dialog for release v2.14.0 with two highlights. Under "Filter work orders by priority" is a captured screenshot of a Work orders list, with Include in email unticked, a Change button, Add image and Capture screenshot. Under "Saved reports" is an empty image slot whose reason begins "The screen could not be re…", with Change, Add image and Capture screenshot. The footer reads "0 of 1 image included" beside Include all, Reject and Approve & send as text

In the review dialog you can also click Capture screenshot under a highlight and describe the screen you want, or open a captured screenshot and click Capture again. A capture takes a minute or two, and the dialog updates when it finishes. When a new capture fails, the previous screenshot stays.

A capture never stops a newsletter from being sent: a highlight whose screenshot failed goes out as text. Each capture is logged as AI usage under the newsletter screenshot job.

Send history

Send & history lists every send with its trigger, status and delivery count. Click Send now to start one immediately.

StatusMeaning
Preparing…Fabric is writing a newsletter that will be held for review.
Awaiting reviewHeld until an admin approves or rejects it.
Sending…, Sent, Partially sent, FailedDelivery progress and outcome.
Rejected, Review expiredNot delivered.
No new releases, No major updatesNothing new to announce, so nobody was emailed.
Scan incompleteFabric could not read every connected repository, so it sent nothing. A partial scan could miss a release. The row lists the repositories that failed and the error each returned.
No subscribersThe audience is empty.
Repositories disconnectedThe project has no active repository connection.

Fixing a scan that is incomplete. The reason under Scan incomplete names the repository. Give the connected account access to it, or remove the repository from the project under Settings → Development, then click Send now. If a repository's credentials have expired, the newsletter settings show a Reconnect repositories banner.

Embed on your site

Under Embed, turn on Enable the embeddable widget to publish the project's release notes at a public widget URL. Style the widget to match your site, then paste the snippet into your HTML.