Manage Frogbot Workspaces

Use Frogbot workspaces to split a Git repository into named scan units. Each workspace has its own scan configuration, so a monorepo can apply different scanners, include paths, and auto-fix settings per application. Workspaces are available for Frogbot V3 repository scans.

Every Git repository has a default workspace that covers the full repository. Frogbot uses default when you do not set a workspace name.

This feature is part of Frogbot V3 centralized configuration. For more information, see Frogbot V3 and Advanced Management and Configuration.

The following tasks explain how to use workspaces:

• Create a Workspace
• Rename or Delete a Workspace
• Configure Scan Settings for a Workspace
• Scan a Workspace with Frogbot
• View Workspace Scan Results

Prerequisite: Frogbot V3 is connected to your Git provider, and Xray has indexed the Git repository. Workspaces require JFrog Xray 3.150 or later.

Create a Workspace

Create named workspaces on a Git repository when you need separate scan configuration for applications in the same repository. You can't rename or delete the default workspace.

To create a workspace:

1. Go to Administration > Xray Settings > Indexed Resources > Git Repositories.

2. Open the Git server and folders until you reach the repository.

3. From the repository row actions, click Manage Workspaces.

   You can also click Configure, open the Workspace list, and click Manage Workspaces.

   The Manage Workspaces view opens.

4. Click + Add Workspace.

5. Enter a unique workspace name, and click Save.

   Duplicate names in the same repository are rejected.

The workspace appears in the Workspace list for that repository. Settings you apply next apply only to the selected workspace.

Rename or Delete a Workspace

Rename a workspace when the application name changes. Delete a workspace you no longer need. You can't rename or delete the default workspace.

To rename or delete a workspace:

1. Go to Administration > Xray Settings > Indexed Resources > Git Repositories.

2. From the repository row actions, click Manage Workspaces.

3. Do one of the following:

   • To rename the workspace, click the edit action, enter the new name, and click Save.
   • To delete the workspace, click the delete action, and confirm.

Deleting a workspace moves existing scan records for that workspace to default.

Configure Scan Settings for a Workspace

Select a workspace in the Frogbot Configuration drawer, then apply scanners, include paths, auto-fix, and pull request decorations for that workspace only. Server and folder configuration does not use workspaces.

To configure scan settings for a workspace:

1. Go to Administration > Xray Settings > Indexed Resources > Git Repositories.

2. Select the Git repository, and click Configure.

   The Frogbot Configuration drawer opens.

3. In the Workspace list, select the workspace.

4. On the Scans Configuration, Auto-Fix, and PR Decorations tabs, set the options for this workspace.

5. To limit the scan to an application directory, set Global Include Paths for that workspace. Use Global Exclude Paths to skip paths inside the workspace.

6. Click Apply.

Later Frogbot scans that send this workspace name use these settings. For scanner options, see Advanced Management and Configuration.

Scan a Workspace with Frogbot

Pass the workspace name in CI so Frogbot loads that workspace configuration and reports results under that workspace. If you omit the variable, Frogbot uses default.

To scan a workspace with Frogbot:

1. Confirm the workspace exists on the Git repository in the JFrog Platform.

2. In the Frogbot V3 workflow for frogbot scan-repository or frogbot scan-pull-request, set JF_GIT_WORKSPACE to the workspace name.

   YAML

   env:
     JF_URL: ${{ secrets.JF_URL }}
     JF_ACCESS_TOKEN: ${{ secrets.JF_ACCESS_TOKEN }}
     JF_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     JF_GIT_WORKSPACE: <workspace name>

   Where:

   • <workspace name>: The workspace name as it appears in the JFrog Platform

   For example:

   YAML

   env:
     JF_URL: ${{ secrets.JF_URL }}
     JF_ACCESS_TOKEN: ${{ secrets.JF_ACCESS_TOKEN }}
     JF_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     JF_GIT_WORKSPACE: payments-service

3. Run the commit scan or pull request scan as usual.

Frogbot fetches the configuration profile for that workspace and uploads results with the workspace name. For CI setup, see Scanning Commits and Pull Requests.

View Workspace Scan Results

Commit and pull request tables show which workspace produced each scan. You can filter those tables by workspace. The Workspace column and filter appear for Frogbot V3 and static SCA scans.

To view workspace scan results:

1. Go to Application > Xray > Scans List.

2. Open the Git Repositories tab, and select the repository.

3. Select one of the following tabs:

   • Commits
   • Pull Requests

4. Review the Workspace column, or filter by workspace.

   The table lists scans for the selected workspace.

For more information, see JFrog Platform and View Git Repository Scan Results.

Related Information

• Workspaces exist only on Git repositories, not on Git servers or folders.
• The default workspace always exists and can't be renamed or deleted.
• Frogbot V2 and frogbot-config.yml working directories are a different mechanism. Use workspaces with Frogbot V3.
• For more information, see Advanced Management and Configuration.