Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SYNTH-18711] Update comment about sed syntax support #28482

Conversation

AntoineDona
Copy link
Contributor

@AntoineDona AntoineDona commented Apr 1, 2025

What does this PR do? What is the motivation?

This PR fixes incorrect documentation about URL substitution syntax in Continuous Testing. The documentation previously claimed support for sed syntax and different delimiters, which was incorrect. The changes remove this misleading information.

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

@AntoineDona AntoineDona requested a review from a team as a code owner April 1, 2025 10:50
Copy link
Contributor

github-actions bot commented Apr 1, 2025

Preview links (active after the build_preview check completes)

Modified Files

@AntoineDona AntoineDona force-pushed the antoine.donascimento/SYNTH-18711/remove-sed-syntax-from-doc branch from 636aba0 to d18f7fc Compare April 1, 2025 11:19
Copy link

@teodor2312 teodor2312 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

<div class="alert alert-info">
Apart from the pipe <code>|</code> syntax presented above, <code>resourceUrlSubstitutionRegexes</code> also supports the sed syntax with modifiers: <code>s|&lt;regex&gt;|&lt;rewriting rule&gt;|&lt;modifiers&gt;</code>.</br></br> The sed syntax is often used with a slash <code>/</code> separator, for example: <code>s/&lt;regex&gt;/&lt;rewriting rule&gt;/&lt;modifier&gt;</code>. However, it can use any character as a delimiter. When working on a URL containing an abundant number of slashes, Datadog recommends using another character rather than escaping all slashes of the URL.
Only the pipe <code>|</code> syntax is supported for URL substitution regexes. Sed syntax and other delimiter characters are not supported.
</div>

## Further reading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not you but the what's next thing is broken and we should tell someone :D

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@teodor2312 Can you tell me more about what's broken?

Copy link
Contributor

@Drarig29 Drarig29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do support two syntaxes

@AntoineDona AntoineDona requested a review from Drarig29 April 1, 2025 14:32
Copy link
Contributor

@Drarig29 Drarig29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, let's see what @urseberry thinks about the wording added in 86652ed

@AntoineDona AntoineDona requested a review from urseberry April 2, 2025 08:30
@AntoineDona
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Apr 2, 2025

View all feedbacks in Devflow UI.

2025-04-02 19:33:42 UTC ℹ️ Start processing command /merge


2025-04-02 19:33:48 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 20m (p90).


2025-04-02 19:48:39 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit def65ec into master Apr 2, 2025
14 of 16 checks passed
@dd-mergequeue dd-mergequeue bot deleted the antoine.donascimento/SYNTH-18711/remove-sed-syntax-from-doc branch April 2, 2025 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants