Docs

Project setup

Publish a project

Publishing is the moment an Admin signs off that a Project's setup works. Until then, nobody can start a Workspace from it. Once it's published, everyone on the team can.

Deployed is not published

A Project can be deployed without being published, and the two mean different things. Deployed means the app built and runs. Published means a person checked it and confirmed the setup is right: the app comes up, the screens look like your product, and the Data Twin carries the data people will need.

The difference matters because every Workspace starts from the Project's setup. If people started building on a setup nobody had checked, each of them would inherit its problems and work around them separately. Publishing first means everyone starts from the same setup, and it's one the team has looked at.

Before you publish

While a Project is unpublished:

  • Soffi offers no way to start a new Workspace from it, for any role. The setup work happens in the Workspace Soffi set the app up in.
  • Editors, Admins and Owners can open that Workspace and keep working on the setup. Reviewers can't see it yet.
  • Workspace cards that belong to the Project show In setup while Soffi is still setting it up, then Pending publish beside Deployed once the app runs.
  • Soffi's comment on pull requests in the Project's repository doesn't offer a preview yet. It links to the Project instead, with a note that publishing turns on PR previews for everyone. See PRs opened outside Soffi.

Publish

Admins and Owners can publish. Open the Project from Projects in the left rail and go to Configure. Once the app is running, Publish appears in the page header. Before then it stays disabled with the reason, "You can publish once your app is running".

Publishing makes the setup Workspace's setup the starting point for every new Workspace. When you confirm, Soffi:

  1. Saves the Workspace's committed setup. Uncommitted edits are left out, and if Soffi is still working in that Workspace, the dialog asks you to wait so its last changes are included.
  2. Builds the Project from it, which takes about 2 to 5 minutes.
  3. Marks the Project ready for new Workspaces.

You can close the dialog while it runs; the progress also shows on the Project.

After you publish

The Pending publish badge disappears, anyone on the team who can start Workspaces can start one from the Project, and pull requests in its repository get a link to preview them.

The setup can still change. When someone improves it in a Workspace, such as a better run configuration or more data in the Data Twin, an Admin can make that the new starting point with Save setup in the same place, choosing which Workspace to save from. It appears only when there's something new to save. New Workspaces start from the saved setup, and existing Workspaces bring it in in the background. See Staying up to date.

Was this helpful?