Ship

Ship is how work leaves a Workspace. It turns what you've made into a pull request in your repository, written up for the people who'll review it, and from then on keeps that pull request up to date as you keep working. In a Workspace opened from a pull request someone already raised, there's nothing new to open: Ship pushes your work to that pull request from the first time. Your team reviews and merges it the way they review any other pull request. See From Workspace to pull request for the bigger picture.

Editors, Admins and Owners can ship. Ship is at the right of the Preview's header in the Grid layout.

Shipping for the first time

Click Ship to open Review and ship. It lists what's going out, grouped by repository, with design system changes and file changes listed separately. Click a token to see it in the Design System panel, or a file to see it in History. Edits you haven't applied yet don't ship, so Soffi asks you to apply or discard them before the dialog opens.

When you click Ship, Soffi saves anything left unsaved, pushes your work, and opens the pull request. You don't write the title or the description: Soffi writes them from what changed, while the dialog is open. Before and after screenshots of the screens you changed are added to its description as well. See PR visuals.

One pull request per repository

A Workspace can change more than one repository, for example your design system and the app that uses it. Ship opens one pull request in each repository the Workspace changed, all from the same dialog. A Workspace opened from an existing pull request works in that pull request's repository only. If one of them fails, the others still go through, and Retry re-ships only the one that failed.

Who opens the pull request

Next to each repository, the dialog says who the pull request will open as. If you've signed in to GitHub from Soffi and have write access to that repository, it opens under your own GitHub account. Otherwise, it opens as Soffi, through your Organization's GitHub app, and the reason is shown when you hover the note. Shipping works either way. The chip at the bottom left shows whether you're signed in to GitHub, with Authenticate if you're not or your session has expired. See GitHub.

Shipping again

Keep working after you ship, and the Workspace keeps track of what's new. The next time you click Ship, the dialog shows Push changes to PR #N for each repository with an open pull request, and your new work goes onto the same pull request rather than a new one. When there's nothing new to ship, the button takes you to your pull requests instead.

Once all of the Workspace's pull requests have merged, Soffi archives the Workspace.

Keeping in sync

Other people can change your pull request too: a reviewer pushing a fix, or an engineer finishing something off locally. You don't need to bring their work in. Soffi pulls new commits on your pull request, and updates from the Project, into your Workspace on its own and refreshes the Preview. If an update overlaps your edits, Soffi resolves it in the background and asks you only when it would change UI you're editing. Updates stay in the Workspace until you ship, and go out with your work the next time you click Ship.

Sync status, in the header of the right-hand panel, shows where each repository stands, from Up to date to Needs your input, and Check for updates looks for new work straight away. See Staying up to date for every state and what happens in each.