Force code review before deploying nodes in DataWorks to block invalid code from occupying compute resources and stalling other nodes. When enabled, a node cannot be committed or deployed until a designated reviewer approves the code.
Prerequisites
Before you begin, ensure that you have:
-
DataWorks Professional Edition or a more advanced edition. For edition comparison and purchase information, see Differences among DataWorks editions and Purchase guide
-
The Workspace Administrator role. For details, see Overview of users, roles, and permissions
-
At least one node created for data development. For details, see Overview
How it works
When multiple nodes run in parallel, higher-priority nodes get resource access first. If a high-priority node fails due to invalid code, it holds computing resources for an extended period — wasting capacity and potentially blocking lower-priority nodes from running.
The forcible code review feature addresses this by adding a code quality gate before commit and deployment. Add high-priority nodes to a baseline, then enable forcible code review for that baseline. A designated reviewer must approve the code before the node can proceed.
The following table summarizes how the feature affects the commit and deployment process.
| Status | Behavior | Impact on commit and deployment |
|---|---|---|
| Disabled | When you commit a node, DataWorks notifies the specified code reviewer of the changes. All workspace members, regardless of role, can be configured as the code reviewer. | Not affected. The node is committed and deployed normally. |
| Enabled | A qualified reviewer must be specified when committing a node. If you delete a node, code review is not triggered on commit. | Blocked until review is complete. If the code passes, the node is committed and can be deployed. If it fails, you must fix the issues before the node can proceed. |
Limitations
-
Only DataWorks Professional Edition or higher supports this feature.
-
Only Workspace Administrators can enable or disable the feature.
-
The following node types do not support code review: combined nodes (do-while nodes and for-each nodes), and non-Python resource files.
Enable code review and configure parameters
This step is performed by the workspace administrator.
-
Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Development and Governance > Data Development. Select the workspace and click Go to Data Development.
-
Go to the Security Settings and Others tab.
-
In the lower-left corner of the DataStudio page, click the
icon. The Personal Settings tab appears. -
Click the Security Settings and Others tab.
-
-
In the Code Review section, turn on Force to review code and configure the parameters.
Parameter Description Force to review code Enables or disables the feature for the current workspace. On: A reviewer must approve the node code before it can be committed or deployed. Off: Nodes can be committed and deployed without review. A reviewer can still be notified of changes when the toggle is off, but the commit and deployment processes are not blocked. Code reviewers Determines who can review code when nodes are committed. Any Developer Role: All users with the Develop role in the workspace are available as reviewers. The code passes after any one reviewer approves. Specify development role users: You designate one or more specific users. The code passes only after all specified reviewers approve. Only users with the Develop role can be selected as reviewers. Baseline scopes for code review Defines which nodes require review, based on the priority of the baseline they belong to. Set this to Non-baseline tasks to apply review to nodes not in any baseline. Set it to one or more specific baseline task levels to apply review to nodes in those baselines. Higher baseline task levels indicate higher priority. Nodes in a baseline have higher priority than non-baseline nodes. For more information, see Overview. Code reviewers and Baseline scopes for code review can only be configured after Force to review code is turned on.
Initiate code review
This step is performed by the developer.
Code review is triggered when you commit a node. After selecting a reviewer, the system generates a code review ticket.
If you initiate code review again while a previous review is still in progress, the previous review result becomes invalid. If you delete a node, code review is not triggered on commit.
The review process and entry points differ by workspace mode.
Standard mode
In standard mode, the commit and deployment processes are blocked until the code passes review. After approval, the node is committed and can be deployed from the Deploy page.
Initiating review for a single node:
-
In the dialog box that appears when you commit the node.
-
By clicking the commit icon in the top toolbar on the node configuration tab.
Initiating review for multiple nodes at a time:
-
In the dialog box that appears when you commit the workflow that contains the nodes.
-
On the Deploy page, click Create Package in the left-side navigation pane. On the Create Deploy Task page, select the nodes and initiate review. For details, see Deploy nodes.
Basic mode
In basic mode, clicking Only Initiate Code Review in the commit dialog initiates the review without committing the node. After the code passes review, click Submit again to commit the node to the production environment.
Initiating review for a single node:
-
In the dialog box that appears when you commit the node.
Initiating review for multiple nodes at a time:
-
In the dialog box that appears when you commit the workflow that contains the nodes.
View and process code review tickets
This step is performed by the code review initiator and the code reviewer.
-
Go to the Code Review page using one of the following methods:
-
In the upper-left corner of the DataStudio page, click the
icon and choose All Products > Data Development And Task Operation > Code Review. -
On the node configuration tab, click the
icon in the top toolbar.
-
-
View and process the review tickets.
The Code Review page is divided into three areas.
Area Description 1 Switch between Review by Me (code reviewer view) and Submitted by Me (code review initiator view). 2 Filter tickets by code review status, node name, node type, code review initiator, and node commit time. 3 View node details including version and review status. Perform review actions on tickets. The following actions are available in area 3.
Action Description Version comparison Compare node code across versions to understand what changed. Write a comment Add a comment on the current node version. Pass Approve the code. After passing, the review checker runs, and the initiator can deploy the node from the Deploy page. For deployment instructions, see Deploy nodes. Do not pass Reject the code. If Force to review code is on, commit and deployment are blocked. If it is off, the node can still be committed and deployed. Abandoned Abandon the current review. The node can continue to be committed and deployed after abandonment. Reopen Reopen an abandoned review.