[DR-520] docs: flat release-job validation config reference#10469
Open
avalcepina wants to merge 2 commits into
Open
[DR-520] docs: flat release-job validation config reference#10469avalcepina wants to merge 2 commits into
avalcepina wants to merge 2 commits into
Conversation
Document validation.enabled, webhooks, and agents under type: release jobs, replacing the nested validation_policy shape. Co-authored-by: Cursor <cursoragent@cursor.com>
4 tasks
rosieyohannan
requested changes
Jun 22, 2026
| === *<``job_name``>* | ||
|
|
||
| Each job consists of the job's name as a key and a map as a value. A name must be unique and case-insensitive within the `jobs` list. The value map has the following attributes: | ||
| Each job consists of the job's name as a key and a map as a value. A name must be case insensitive unique within a current `jobs` list. The value map has the following attributes: |
Contributor
There was a problem hiding this comment.
This sounds a bit awkward, maybe...
Suggested change
| Each job consists of the job's name as a key and a map as a value. A name must be case insensitive unique within a current `jobs` list. The value map has the following attributes: | |
| Each job consists of the job's name as a key and a map as a value. A name must be unique within a current `jobs` list. Job names are case insensitive. The value map has the following attributes: |
| Release jobs can optionally enable the deploy validation engine with a flat configuration (no nested `validation_policy` block). | ||
|
|
||
| * `validation.enabled` — when `true` and no `webhooks` or `agents` are listed, creates a default Datadog webhook validation named `default`. | ||
| * `webhooks` — optional list of webhook checks. Each entry requires `name` and `type` (`datadog` or `custom`). |
Contributor
There was a problem hiding this comment.
Suggested change
| * `webhooks` — optional list of webhook checks. Each entry requires `name` and `type` (`datadog` or `custom`). | |
| * `webhooks`: Optional list of webhook checks. Each entry requires `name` and `type`. The `type` can be one of either `datadog` or `custom`. |
| The `no-op` type is used to configure a job that performs no actions and consumes no credits. `no-op` is commonly used to organize the order of operations within a workflow and make it easier to maintain. Only the `type` is required for a `no-op` type job, no further job configuration is required. For some examples of using `no-op` jobs, see the xref:guides:orchestrate:orchestration-cookbook.adoc#use-no-op-jobs-to-create-a-cleaner-workflow-graph[Orchestration Cookbook]. | ||
| Release jobs can optionally enable the deploy validation engine with a flat configuration (no nested `validation_policy` block). | ||
|
|
||
| * `validation.enabled` — when `true` and no `webhooks` or `agents` are listed, creates a default Datadog webhook validation named `default`. |
Contributor
There was a problem hiding this comment.
Suggested change
| * `validation.enabled` — when `true` and no `webhooks` or `agents` are listed, creates a default Datadog webhook validation named `default`. | |
| * `validation.enabled`: When `true` and no `webhooks` or `agents` are listed, creates a default Datadog webhook validation named `default`. |
|
|
||
| * `validation.enabled` — when `true` and no `webhooks` or `agents` are listed, creates a default Datadog webhook validation named `default`. | ||
| * `webhooks` — optional list of webhook checks. Each entry requires `name` and `type` (`datadog` or `custom`). | ||
| * `agents` — optional list of agentic checks. Each entry requires `name` and `prompt`; `tools` (default `datadog`) and `frequency` (default `5m`) are optional. |
Contributor
There was a problem hiding this comment.
Suggested change
| * `agents` — optional list of agentic checks. Each entry requires `name` and `prompt`; `tools` (default `datadog`) and `frequency` (default `5m`) are optional. | |
| * `agents`: Optional list of agentic checks. Each entry requires `name` and `prompt`; `tools` (default `datadog`) and `frequency` (default `5m`) are optional. |
Contributor
There was a problem hiding this comment.
Might put these in a table actually
| * `webhooks` — optional list of webhook checks. Each entry requires `name` and `type` (`datadog` or `custom`). | ||
| * `agents` — optional list of agentic checks. Each entry requires `name` and `prompt`; `tools` (default `datadog`) and `frequency` (default `5m`) are optional. | ||
|
|
||
| Validation runs when any of `validation.enabled`, a non-empty `webhooks` list, or a non-empty `agents` list is set. |
Contributor
There was a problem hiding this comment.
Suggested change
| Validation runs when any of `validation.enabled`, a non-empty `webhooks` list, or a non-empty `agents` list is set. | |
| Validation runs when any of the following are set: | |
| * `validation.enabled` is true. | |
| * A non-empty `webhooks` list. | |
| * A non-empty `agents` list. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the flat release-job validation config under
type: release:validation.enabledwebhooks[](name,type: datadog or custom)agents[](name,prompt, optionaltoolsandfrequency)Includes a full YAML example. Replaces the nested
validation_policydocumentation approach.Companion to release-tracker PR: https://github.com/circleci/release-tracker/pull/2114
Linear: https://linear.app/circleci/issue/DR-520
Test plan