Onset - Release Notes

Developers rejoice. Onset JavaScript SDK is officially here! We have made three different packages available for your disposal. All packages are available via NPM and YARN and include type definitions.

`@onsetio/browser`

Primarily used in the browser for loading public releases.

`@onsetio/node`

Onset API JavaScript interface.

`@onsetio/widget`

We recommend that you should always be loaded the Widget.js script directly from https://widget.onset.io/widget.js, rather than including it in a bundle or host yourself. If must bundle the Widget code into your application, you can use this package.

SDK JavaScript

Hola! Bonjour! Guten tag! Olá! Hallo!

We are excited to share that you can now change the default language of your public page. This highly anticipated feature is currently in public beta and only available to our 👬 Team and 👔 Business members.

Languages we are currently supporting:

English
Español
Português
Français
Deutsch
Nederlands

You can enable this feature via Settings → Labs. Once turned on, you should see a “Page Language” dropdown in the Settings → Appearance section of your page settings.

Also, don’t be worried. The selected language will also apply to the release notifications.

If you require translation to another language, no problem, reach out to us!

Feature Announcement Preview

We got a ton of new features for you! A few notable ones are:

Unread release badges - notify your users of new releases by showing the count in the trigger badge. We check for new releases every five(5) minutes.
Widget directions - adjust the direction widget window appears. You can emulate a modal window.
Events - subscribe to widget events. Read more about them in our doc.

Added	Added a trigger badge that shows the count of unread releases.
Added	Added new `hideBadge` attribute to hide the new trigger badge count.
Added	Added new `direction` and `triggerDirection` attributes to specify the direction in which the widget should appear. `direction` - accepted values: `left`, `right`, `center`. `triggerDirection` - accepted values: `left`, `right`.
Added	Added new `width` attribute to specify the width of the widget. Useful for when using the `center` direction and simulating a modal window.
Added	Ability to click on the release links.
Added	Added new `ready` event. Triggered when the widget is loaded and ready to go.
Added	Added new `new_release` event. Triggered when new release is available.
Added	Added new `read` event. Triggered when new release is read.
Fixed	Fixed the Subscribe button URL
Fixed	Fixed the project scoping.
Fixed	Fixed the release change list font size.

Feature JavaScript

We’ve gone dark y’all! We are following up on our previous release and rolling out dark mode for our widget. Unlike the page, dark mode is enabled programmatically, with no toggles.

While embedding the widget, now you have an optional theme attribute that you can pass. It accepts one of three values:

light - light theme
dark - dark theme
auto - auto-detect based on the user’s computer system settings

We are defaulting to our usual light theme to avoid shocking your eyes with the new theme. In the future, this property default value be changed to auto.

onsetWidgetSettings = {
  page: 'releases.onset.io',
  triggerText: "🔔 What's New",
  theme: 'dark',
};

Check out our widget documentation for more configuration options.

Feature JavaScript

We’ve got a special gift for you today - Onset dark mode. It’s finally here! Page light and dark themes are automatically toggled based on your computer’s system settings. Of course, you can override the system settings by manually toggling the switch in the header.

P.S. Don’t forget to upload a dark mode-friendly version of your logo in the Settings → Appearance.

Feature Announcement

We worked on our editor and made various changes that we are proud to share. The main one that we are most excited about is the new image upload functionality.

Previously, we only allowed you to embed images via URL from an external source. We understand that it was somewhat of a frustrating process, so we decided to fix it. You can now upload images directly to the platform without using any other third-party hosting, and it’s completely free.

🤔 Did you know?
While adding changes, you can use cmd/ctrl + return to add a new change line item.

Added	Ability to upload images directly in the editor.
Added	Option to add ordered list items.
Added	Added `.ico` image support for page icons.
Fixed	Fixed various billing subscription bugs.

Improvements Feature Editor

We cooked up another new feature, Labels! Create labels to help organize and filter releases across projects.

Added	From Address - send release notification from a custom email address.
Added	Option to create organizations without a sample data.
Changed	Changed the public release indicator to something little fancier.
Fixed	Fixed the various integration settings page bugs.

Feature Announcement

Added	`/labels` - endpoint to retrieve, create, edit and delete labels.
Added	To label releases, you can pass array of `label_ids` in the release payload.
Changed	Returning `slug` in the release payload.
Changed	Updated the documentation with better examples.
Fixed	Fixed the `DELETE` endpoints.

Improvements Feature

You can now insert Loom videos into your release notes!

Here is an example of a valid Loom video URL:

https://www.loom.com/share/f8e954b12c0446db8dc0df0fba4d5722

Added	Loom video support.
Added	Ability to edit already embedded videos, images and links.
Fixed	Disabled the href links while editing, so you can easily update them.
Fixed	Fixed the Mailchimp sync and using the original subscriber timestamp as the subscription date.

Feature Editor

Our editor now automatically converts certain characters to correct typographic characters. If you want to undo the converted result, just hit Backspace once.

Symbols

(c) to a copyright sign ©
(r) to registered trademark sign ®
(tm) to registered trademark sign ™

Math

1/2 to one half ½
1/4 to one quarter ¼
3/4 to three quarters ¾
+/- to plus/minus sign ±
!= to a not equal sign ≠
2 * 3 or 2x3 to a multiplication sign 2×3
^2 a superscript two ²
^3 a superscript three ³

Quotes

“Smart” opening double-quotes
“Smart” closing double-quotes
‘Smart’ opening single quotes
‘Smart’ closing single quotes
<< to left-pointing double angle quotation mark «
>> to right-pointing double angle quotation mark »

Other

-- to an emdash —
... to an ellipsis character …
<‐ to an arrow ←
‐> to an arrow →

Editor

You can now add links to your website and other important resources in the header of your release notes page.

Just add the URLs you'd like to link to, and they'll appear in the header. If you add social media links, they'll appear as clickable icons on the sidebar.

Added	Added new Header Links section to the Settings → External Links page.
Added	Unsaved release discard notification so you don't accidentally lose your work.
Added	Outdated draft release date highlight.
Added	Added ability to display release author info. Enable it via the Settings → Privacy page.
Fixed	Slack integration settings.
Fixed	`<pre>` tag responsiveness fix.

We made some exciting changes to the editor.

Code Blocks

To add a code block, use the insert menu of the editor or just type three backticks ( ```) at the start and end of your code snippet. Your finished code block will look like this:

Array(13).join('wat' - 1) + ' Batman!'; // Theme song!

Quotes

To create a blockquote, start a line with greater than (>) followed by a space or insert it via the menu.

I'm not saying I'm Batman. I'm just saying no one has ever seen Batman and me in the same room together.

Added	`CMD/CTRL + RETURN` shortcut to add new release change.
Added	Added image url validation. Supported formats are, `PNG, JPG, GIF, SVG`.
Fixed	Disabled the video controls in the editor.

In this release, we are focusing on page privacy. Password-protected pages are now available for preview. Lock your page and only allow those with the password to view it.

Currently, the password-protected privacy layer must be turned on via the Labs settings. To enable the feature for your workspace, please navigate to Settings → Labs.

Password-protected pages are available for paid customers only, Team Plan, and above.

Added	Disable public subscribers.
Added	Disable search engines from crawling your release notes.
Added	Password-protected page.
Fixed	Statuspage loading bug.

Added	Ability to drag and sort release changes.
Added	New Zapier integration. Onset API must be turned on via the Lab settings.
Added	New page privacy settings screen.
Added	Password-protected pages are now available for preview.
Changed	More prominent pinned release indicator.
Changed	Moved the release project selection to the compose screen.
Changed	On release update, all integrations and email toggles are disabled by default.
Changed	Alphabetically sorting projects in the navigation.
Removed	Removed the project list dropdown from the "New Release" button.
Fixed	Fixed the public release URL button in the main navigation.
Fixed	Fixed the release permalink not updating correctly.

Added	Release visibility - control who can view your updates on an individual release note basis.
Added	Pinned releases - pin the most important releases to the top of the page.
Added	Onset Labs - experiment with our latest and greatest features before they're available to everyone.
Changed	Webhooks are now relocated under the integrations section of the app.
Changed	From now on, subscribers are categorized into two groups, public and private. Private Subscribers - receive notifications for both public and privately published releases. Public Subscribers - only receive notifications about publicly published release notes. Public page subscribers are automatically categorized as "Public Subscribers."
Removed	Removed the project-level privacy toggle to make way for the new release-level visibility management.

The Onset API is now available for all developers to explore and build upon. Integrations built on the API are available to all Onset users on free or paid plans.

Currently, Onset API is must be turned on via the Labs settings. To enable the API for your workspace, please navigate to Settings → Labs.

To learn more, visit the API Reference section in our docs.

Please Note: The current version of the web API is considered a draft phase. While we don’t expect public endpoints to change greatly, keep in mind that the API is still under development.

We have been tirelessly working on updating the release creation process. Our goal was to provide a seamless experience that allows you to see precisely how your releases would look without needing to publish them.

Added	New Editor - rich text editor, markdown is still supported.
Added	Permalink- set custom release URL slugs.
Added	Author - ability to select and change release author.
Removed	Mute toggle replaced with publish window.
Fixed	Fixed submitting draft release email notifications.
Fixed	Fixed image responsive rendering.
Fixed	Fixed YouTube and Vimeo video player responsive rendering.
Fixed	Fixed the sample release creation bug.

Our newest, fastest, best-performing, shiniest, most nutritious, and delicious version of Onset is now fully rolled out, so that's the one you're now using. Brilliant.

Added	All Releases - view all your release notes across your projects under one umbrella.
Added	Ability to search across all your projects.
Changed	Consistent look and feel between your private and public release notes.
Changed	Moved the settings button to the Projects page.
Changed	Moved the Privacy settings into Project settings page.
Changed	Displaying release reactions percentile.
Changed	Increased the Project name maximum limit to 30 characters.
Removed	Removed the Project grid view.
Removed	Removed the Project search bar.

Our design and development team has been diligently laboring over every last detail of Onset Pages for the last several months. Today we are so excited to show off this brand new way to use public pages.

Here are a few highlights:

All Releases - all your release notes under a single page.
New Sidebar - floating sidebar that allows your users to search quickly and toggle between projects.
Subscription Window - the ability for your readers to subscribe to multiple projects at once.

Changed	Improved Project selection type experience.
Changed	Updated Slack integration icon.
Fixed	Fixed subscribers not page reloading.

Migrate the contacts that you have collected in Mailchimp to Onset with ease as there's no need to export them first and import from file later.

To learn how to click here.

Added	New Mailchimp subscriber import.
Added	New Calendar Versioning support.
Added	Displaying social links in the release email footer.
Changed	Updated the release email templates.
Changed	Minor UI tweaks.
Fixed	Fixed the `/unsubscribe` link.
Fixed	Fixed the CSV Import.
Fixed	Fixed the release not clearing after deletion.

We are excited to announce support for video embeds.

To add a video to your release, simply click on the new film icon in the editor:

Or wrap the video link in a markdown like so:

![Beautiful Nature](https://www.youtube.com/watch?v=DGQwd1_dpuc)

The code above will result in 🌊:

Video embed support is currently limited to YouTube and Vimeo.

Changed	Updated the release meta view.
Fixed	Fixed the GitHub refrerence link.

Added	Displaying RSS feed icon.
Added	JSON & RSS feeds are now available across all projects. Example: `https://releases.onset.io/feed.json` `https://releases.onset.io/feed.xml`
Added	YouTube and Vimeo video support.
Changed	Always displaying title in the JSON and RSS feeds.
Changed	Added hyperlink to the release title.

After numerous requests and feedback, we are delighted to announce the new version-less projects. We understand that some projects might be composed of multiple technologies, API, UI, and services, etc...

Projects without versioning enables you to compose releases about your product, rather than a single service.

Added	Release reactions.
Added	New project type.
Fixed	Fixed the project name not showing up in the email subject.

Reactions let users rate a release. Once a customer finishes reading your release, they can let you know how they feel about it by reacting with a happy, neutral or disappointed face.

Added	Ability to revert published releases back to draft.
Added	Sentry Integration
Changed	Showing full release dates.
Fixed	Fixed the release text overflow bug.

Added	XML release reponse: Project: `https://:organization.onset.io/:project.xml` Release: `https://:organization.onset.io/:project/:version.xml`
Added	Added project and release URLs to `XML` and `JSON` responses.
Fixed	Fixed the text wrapping.
Security	Loosening the CORS requirements.

Fixed	Fixed the datepicker formatting.
Fixed	Fixed the past relese dates not being set correctly.

Added	Ability access latest version of directly projects using the `/latest` URL. Example: `https://releases.onset.io/application/latest` `https://releases.onset.io/application/latest.json`
Fixed	Fixed the linebreaks not rendering properly.
Fixed	JSON endpoints are showing the correct versions.
Fixed	JSON endpoints are showing the correctly HTML formatted description.

We are excited to introduce a new release creation behavior. From now on, all your new releases are automatically saved as a draft in order to avoid loosing any of your changes.

Added	Auto-save the draft releases.
Added	Alert on closing un-saved drafts.
Added	No content message.
Added	Tooltip with organization name in the organization switcher icon.
Changed	Release drafts are visible on the organization level.
Changed	Release notification `FROM:` name now uses organizaton name.
Fixed	Fixed the release date-picker bug.

Fixed	Fixed the release date timezone issue.
Fixed	Fixed the incorrect markdown header render.

Fixed	Ignoring duplicate subscribers.
Fixed	Better email validations, espcially for the devices that don't support `email` field types.

Added	Added project name to all release page headers.
Added	Mailchimp Integration - Sync your Page subscribers with MailChimp.
Fixed	Fixed the header height on the smaller devices.
Removed	Removed the project name from the header.

Added	You must cancel a scheduled release in order to edit it.
Changed	Rebuilt our API ground up.
Fixed	Fixed the signup related issue.
Fixed	Fixed the time-zone ampersant bug.
Security	Upgraded the Google Authentication.

Changed	Renaming this project to "Pages".
Changed	Changed the project JSON endpoint to: Project: `https://:organization.onset.io/:project.json` Release: `https://:organization.onset.io/:project/:version.json`
Removed	Removed the dramatic shadowing.
Removed	Removed the individual project based search, it was causing a lot of confusion.
Removed	Removed the organization level JSON.

Added	Added Public Page access button to the main navigation.
Added	Added Integrations page.
Added	Added icons to the releases page to indicate the enabled integrations.
Changed	Integrations are now Organization based and only required to be enabled once.
Deprecated	Release notification via Mailchimp is no longer available.
Fixed	Fixed the organization deletion bug.
Removed	Public page button from organization settings.
Removed	Integrations page from organization settings.
Removed	Integrations page from project settings.

Added	Displaying pending invitations in members page.
Added	Google Analytics Integration for public pages.
Changed	Improved the member invite validation.
Fixed	Fixed the confirmation page redirect error.
Fixed	Fixed the member invite bug.
Fixed	Fixed the error notifications.

Changed	Using the custom domain in Slack and Webhooks notifications for public projects.
Fixed	Fixed the user signup bug.
Fixed	Fixed the release on date not being set

Added	Integrated with Intercom.
Changed	Moved the page customization under the general settings.
Changed	Changed the release log input style.
Changed	Changed the primary color to match the new look and feel.
Changed	New release change log design.
Removed	Removed the changeset icons.
Removed	Removed Drift.

Changed	New release change log design.
Changed	Showing status.io widget across all pages.

Added

Added release title into JSON response.

Added	Custom page projects order sorting.
Changed	Changed the Statuspage Integration to just to use the page url rather than API and Page ID.

Added	Statuspage.io integration to public pages.
Deprecated	Weekly digests to subscribers.

Added	Statuspage integration.
Added	Ability to search across and within projects.
Fixed	Text overflow of long project titles.

Added	Bitbucket integration.
Added	Added qucik "Integration" access button.
Added	Added Onset byline to the Github tag body.
Changed	Improved the release and project search.
Changed	Truncating long project name.
Changed	Showing oragnization name in the release email if logo is not set.

Changed	Changed the user endpoint to accept non JSON API format.
Changed	Hiding release public link from draft and schedueld releases.

Added	Subscibers page, to show all organization and project subscriber in a single place.
Added	Added "view" link to all public releases.
Changed	Improved the form field styles.
Changed	Hiding the search bar in projects by default.
Removed	Project level subscribers pages.

Added	New release title toggle option.
Added	Free form toggle.
Changed	Public pages with single project, at the root level (`/`) redirected to project page.
Fixed	Fixed the organization permission bug.
Fixed	Fixed the GitHub login.

Added	`JSON` endpoint to all public pages, example: releases.onset.io/application.json
Changed	Public pages are availabe for public beta. 🎉🎉🎉

Hello there,

We are super excited to introduce our public releases pages. It's still in beta and we are hand picking organizations for testing.

If you would like to be part of the beta, feel free to reach out to us via support@onset.io

Key Features:

Public projects visible to all your visitors.
Allow visitors to subscribe to your projects.
Custom page branding.
Custom domain.