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

Update to explicitly call out the default value for dataPath #584

Merged
merged 2 commits into from
Feb 3, 2025

Conversation

A1shK
Copy link
Contributor

@A1shK A1shK commented Feb 3, 2025

The docs used the word "enable" that made us think that if a dataPath isnt provided, the constants will not be overridable through content. However, looking at the code thats not true.

Change Type (required)

Indicate the type of change your pull request is:

  • patch
  • minor
  • major
  • N/A

Does your PR have any documentation updates?

  • Updated docs
  • No Update needed
  • Unable to update docs

Release Notes

Updated docs for Shared Constants Plugin to highlight the default dataPath used for overriding values

…for dataPath

The docs used the word "enable" that made us think that if a `dataPath` isnt provided, the constants will not be overridable through content. However, looking at the code thats not true

https://github.com/player-ui/player/blob/7e2c1a691ea8e0aae1f2c412d145dcb4749d7164/plugins/shared-constants/core/src/index.ts#L45
KetanReddy
KetanReddy previously approved these changes Feb 3, 2025
@KetanReddy KetanReddy added patch Increment the patch version when merged skip-release Preserve the current version when merged labels Feb 3, 2025
@KetanReddy
Copy link
Member

Hey @A1shK, approved the PR in principle. Can you write release notes for though?

…nts.mdx

Co-authored-by: Ketan Reddy <KetanReddy@users.noreply.github.com>
@KetanReddy KetanReddy enabled auto-merge February 3, 2025 17:06
@KetanReddy KetanReddy merged commit 0fae159 into player-ui:main Feb 3, 2025
7 checks passed
Copy link

codecov bot commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.76%. Comparing base (b68deb2) to head (070c014).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #584      +/-   ##
==========================================
- Coverage   89.84%   89.76%   -0.09%     
==========================================
  Files         331      331              
  Lines       19840    19840              
  Branches     1949     1949              
==========================================
- Hits        17825    17809      -16     
- Misses       2001     2017      +16     
  Partials       14       14              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch Increment the patch version when merged skip-release Preserve the current version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants