Skip to content

RUM-19113: Repair historical API link and OpenFeature code fence - #4014

Merged
mariusc83 merged 3 commits into
developfrom
mariusc83/RUM-19113/foundation-doc-cleanup
Oct 23, 2026
Merged

mariusc83 merged 3 commits into
developfrom
mariusc83/RUM-19113/foundation-doc-cleanup

Conversation

@mariusc83

@mariusc83 mariusc83 commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

What does this PR do?

Restores the release 1.2.0 API-surface link with an immutable historical GitHub URL and closes the dependency code fence in the OpenFeature README. The setup heading and its existing anchor now render as documentation.

Motivation

Resolve the two existing documentation findings identified by Foundation onboarding.

Additional Notes

Stacked on #4013; review and merge that PR first. This PR targets the onboarding branch so its diff contains only two documentation fixes. The historical changelog correction is an explicitly user-approved exception to the release-preparation-only guideline, reaffirmed after review. It repairs a broken link in the existing 1.2.0 entry without changing release wording. The target is pinned to that release commit and must not be updated for later releases. Maintainer review of this narrow exception remains welcome.

Ticket: https://datadoghq.atlassian.net/browse/RUM-19113

Validation: Foundation gate returned allow against the onboarding parent, with both findings resolved, no remaining findings, and no evaluation errors. Staged whitespace checks passed; historical API file verified in commit f68d577 (release 1.2.0). No SDK code changes.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Make sure you discussed the feature or bugfix with the maintaining team in an Issue
  • Make sure each commit and the PR mention the Issue number (cf the CONTRIBUTING doc)

@mariusc83
mariusc83 requested review from a team as code owners October 21, 2026 07:42
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-23T07:37:40.949965Z fb6883a New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@mariusc83
mariusc83 marked this pull request as draft October 21, 2026 07:43

@datadog-prod-us1-5 datadog-prod-us1-5 Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bits Code Review: PASS

More details

The historical changelog link references the release 1.2.0 API surface, and the closing code fence restores the OpenFeature setup heading and anchor. The completed static review identified no actionable defects.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Bits Code Review · Commit 622c654

@datadog-prod-us1-5

datadog-prod-us1-5 Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Pipelines  Tests

🎉 All green!

🧪 All tests passed
❄️ No new flaky tests detected

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 71.80% (-0.01%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: fb6883a | Docs | View more details | Give us feedback!

0xnm
0xnm previously approved these changes Oct 21, 2026

@0xnm 0xnm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

it seems it doesn't need to be stacked and can target develop as-is.

@mariusc83
mariusc83 marked this pull request as ready for review October 21, 2026 08:41
@mariusc83

Copy link
Copy Markdown
Member Author

it seems it doesn't need to be stacked and can target develop as-is.

@0xnm yes, but prefer to merge them in order

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 622c6549b0

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread CHANGELOG.md
* [OTHER] Analyse Benchmark reports in the CI
* [OTHER] Fix the flaky test in DataDogTimeProviderTest
* [OTHER] Generate a report on the SDK API changes ([dd-sdk-android/apiSurface](dd-sdk-android/apiSurface))
* [OTHER] Generate a report on the SDK API changes ([dd-sdk-android/apiSurface](https://github.com/DataDog/dd-sdk-android/blob/f68d577ece9599dc4b1bf382688edf14cf20e9ef/dd-sdk-android/apiSurface))

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Move the changelog edit to a release preparation PR

This commit is a documentation cleanup rather than a release preparation change, but it modifies CHANGELOG.md; repository policy reserves changelog updates exclusively for release preparation PRs. Revert this line here and apply the historical link correction during release preparation instead.

AGENTS.md reference: AGENTS.md:L257-L257

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Addressed in b6a402d. Removed the changelog edit from this PR and deferred the historical link correction to release preparation. The final diff is only the OpenFeature closing code fence. Foundation gate against the onboarding parent returns allow: OpenFeature finding resolved, no new findings or evaluation errors; the existing changelog finding remains.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The user explicitly reaffirmed the historical-link correction after discussing this policy finding. Restored it as a narrow exception: only the URL in the existing 1.2.0 entry changes, pinned to that release commit (f68d577). The historical file exists in Git; later releases do not require updating this entry. The PR description now documents this decision for maintainer review. Foundation validation against the onboarding parent passes with both findings resolved; external URL availability is outside that gate’s coverage.

@mariusc83 mariusc83 changed the title RUM-19113: Repair documentation links and formatting RUM-19113: Close OpenFeature setup code fence Oct 21, 2026
@mariusc83 mariusc83 changed the title RUM-19113: Close OpenFeature setup code fence RUM-19113: Repair historical API link and OpenFeature code fence Oct 21, 2026
maycmlee
maycmlee previously approved these changes Oct 21, 2026
@mariusc83
mariusc83 force-pushed the mariusc83/RUM-19112/factorykit-foundation branch from 6b123d6 to 2b13514 Compare October 22, 2026 07:30
Base automatically changed from mariusc83/RUM-19112/factorykit-foundation to develop October 22, 2026 08:38
@mariusc83
mariusc83 dismissed stale reviews from maycmlee and 0xnm October 22, 2026 08:38

The base branch was changed.

@datadog-prod-us1-5 datadog-prod-us1-5 Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bits Code Review: PASS

More details

The static reviewer confirmed that the pinned historical API target exists and the OpenFeature code fence closes correctly. No actionable defects were reported across the supplied comparison, which also includes Foundation onboarding changes.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Bits Code Review · Commit 0204631

0xnm
0xnm previously approved these changes Oct 22, 2026
@mariusc83

Copy link
Copy Markdown
Member Author

@DataDog please fix my ci

@datadog-official

Copy link
Copy Markdown

I can only run on private repositories.

@mariusc83
mariusc83 force-pushed the mariusc83/RUM-19113/foundation-doc-cleanup branch from 0204631 to fb6883a Compare October 23, 2026 07:36

@0xnm 0xnm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

PR description and title should be updated, there is no OpenFeature part anymore.

@mariusc83
mariusc83 merged commit d3486b0 into develop Oct 23, 2026
28 checks passed
@mariusc83
mariusc83 deleted the mariusc83/RUM-19113/foundation-doc-cleanup branch October 23, 2026 08:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants