Skip to content

Projects#

Project is a main unit of an organization within a workspace. It is recommended to create a project per every real software development managed by organization. Each project owns its data, such as test suites, cases, runs and history of executions, exclusively and allows fine-grained access control.

Projects Grid

This guide collects information on how to manage projects in Zebrunner, define project members and their roles.

Default project#

As soon as your workspace is created, the Default project is automatically generated. The workspace creator is automatically added to users as a workspace Admin (Admin group) and to the Default project members list as an Administrator.

Info

Default project is pre-created solely for demonstrational purposes: it allows you to play around with Launcher, test data and dashboards to get an idea of what you'll get once you'll start sending your test data to Zebrunner

The Default project can be edited and deleted in the same way as any other project in the workspace.

Working with projects#

Most operations on a test run can be performed from either the Test runs grid or a detailed Test run view (test results). Below is the summary of key operations.

Info

You need to be an Admin of the workspace to have the ability to create projects

You need to be a project Administrator/Manager or an Admin of the workspace to have the ability to edit and delete projects, and manage project members (add, remove, assign roles)

Creating a project#

To create a new project, perform the following steps:

  1. In the header, press the drop-down Projects menu and press View all projects. Click New project. Alternatively, select Create a Project from projects drop-down
  2. Enter the project name. It can only contain Latin letters, numbers, and spaces, and must be from 1 to 40 characters
  3. Enter the unique project key — the project’s ID that will be used to identify your project. The key must be from 3 to 6 characters and must only contain Latin letters and numbers
  4. Choose whether your project is public or private by using the switch
  5. Upload the project logo if needed
  6. Click Create

Creating a project

The project creator will be automatically added to the project members as an Administrator and will be able to assign other project roles and edit the project.

Projects amount limit

You can create only a certain amount of projects depending on your current pricing plan. If you try to exceed this limit, you’ll get an alert message, and will need to do one of the following:

  • subscribe to a plan with a bigger number of projects available
  • update the current list of projects

Editing a project#

To edit a project, perform the following steps:

  1. In the header, press the drop-down Projects menu and press View all projects
  2. To the right of the project you’d like to edit, press Edit . You can change the project name and key, make the project public or private by using the switch, assign Project Lead, upload the project logo, access the project members list directly
  3. After applying the changes, press Save

Editing a project

Deleting a project#

To delete a project, perform the following steps:

  1. In the header, press the drop-down Projects menu and press View all projects
  2. To the right of the project you’d like to delete, press Edit
  3. Press Delete. Confirm the action by pressing Delete again

The project will be successfully deleted from the list.

Deleting a project

Note

After deleting a project, all the info including test run results and dashboards will be deleted as well

Access control#

There are 2 types of projects in Zebrunner: public and private.

All users in the workspace will have access to all public projects (with certain limitations like view-only permission depending on the role in the workspace and projects).

The information inside private projects is only available to project members and workspace admins. However, private projects are still displayed in the projects list visible to all workspace users, so they can request membership from project representative(s) (typically, a project lead).

To make a project public or private, use the green switch while creating or editing a project.

Private and public projects

Project members and roles#

Default project roles#

Project members may have different roles within every project:

Administrator — CAN add or delete project members with ANY role, edit members roles, edit or delete THEIR projects. CAN perform any actions on test runs and dashboards, including creating, editing, or deleting dashboards.

Manager — CAN add or delete members (with roles except for Administrator), edit members roles (except for Administrator), edit or delete THEIR projects. CAN perform any actions on test runs and dashboards, including creating, editing, or deleting dashboards.

Engineer — CANNOT change project roles, add or delete project members, edit or delete projects they are in. CAN perform all actions on test runs within the project, CAN send dashboards and widgets by email, but CANNOT add, edit or delete widgets or dashboards.

Guest — CANNOT change project roles, add or delete project members, edit or delete projects they are in. CAN only view project members. Have view-only permissions inside the project (cannot run, edit, delete test runs, create, edit or delete dashboards or widgets, but CAN view and send test run results, widgets, and dashboards via email).

Info

If a user is not a member of a certain public project, they have the same permissions as a Guest

Project Lead — an optional role that may be used to mark a project representative within your organization. It can be a project manager, product owner or project coordinator who can be contacted to request access to a project by an external (to the project) user.

Info

Only a project Administrator or Manager can be assigned as Project Lead. Basically, Project Lead has the same permissions as Administrator or Manager

Adding a member to a project#

Info

Within a project, you can only add existing users that were already invited to the workspace (as Admins or Users). Keep in mind that the maximum number of users that you can add to your workspace is determined by the current pricing plan

Info

You need to be a project Administrator/Manager or an Admin of the workspace to have the ability to add project members

To add members to a project, perform the following steps:

  1. Access the Members grid (via Projects grid → Members or from the navigation sidebar of your project)
  2. Press Add members, a new dialogue will appear
  3. Enter the username(s) or email address(es) of the existing user(s) you want to add to the project
  4. Assign the project role (Administrator, Manager, Engineer, Guest)
  5. Press Save

Adding a member to a project

Updating a member role in a project#

Info

You need to be a project Administrator/Manager or an Admin of the workspace to have the ability to update the roles of project members

To update a project member role, perform the following steps:

  1. Access the Members grid (via Projects grid → Members or from the navigation sidebar of your project)
  2. In the Role column, click on the drop-down for the needed member
  3. Select the needed role from the list

Updating a member role

Removing a member from a project#

Info

You need to a project Administrator/Manager or an Admin of the workspace to have the ability to delete members from a project

To delete a member from a project, perform the following steps:

  1. Access the Members grid (via Projects grid → Members or from the navigation sidebar of your project)
  2. To the right of the member you’d like to delete, press Delete
  3. Confirm the action by pressing Delete again

Deleting a project member

Info

At least one Administrator must be present in a project. You cannot delete the only remaining Administrator

Info

You cannot delete yourself from the project or change your role. Please ask other Administrators to do this