Add vite branch plugin - #3922
Open
zeyadkhaled wants to merge 2 commits into
Open
Conversation
Contributor
size-limit report 📦
|
zeyadkhaled
commented
Aug 21, 2026
| "--abbrev-ref", | ||
| "HEAD", | ||
| ]); | ||
| const { stdout } = await execa("git", ["branch", "--show-current"], { |
Contributor
Author
There was a problem hiding this comment.
osdk unstable branch sync now
detects the branch on an unborn branch (fresh git init,
no commits), where rev-parse --abbrev-ref HEAD failed
outright. Detached HEAD now reports "" instead of "HEAD";
both already normalized to "no branch", so nothing else
shifts.
Contributor
Storybook Preview❌ Storybook preview failed to build or deploy for commit |
amishshah
reviewed
Aug 21, 2026
| */ | ||
| export async function getGitBranch(): Promise<string | undefined> { | ||
| /** The current git branch, or `undefined` if git fails. */ | ||
| export async function getGitBranch(cwd?: string): Promise<string | undefined> { |
Member
There was a problem hiding this comment.
I wonder if there's a way to avoid making this an actual npm package would be nice if it's just some code that gets written once but can be imported and built into the package builds?
| @@ -0,0 +1,9 @@ | |||
| --- | |||
| * The environment variable a Foundry runtime sets to the branch the application | ||
| * is checked out on. `@osdk/client` reads it to scope every request. | ||
| */ | ||
| export const FOUNDRY_BRANCH_RID_ENV_VAR: string = "VITE_FOUNDRY_BRANCH_RID"; |
| pinnedBranch, | ||
| await readGitBranch(root), | ||
| ); | ||
| if (injectedBranch === undefined) { |
| * @example | ||
| * ```ts | ||
| * export default defineConfig({ plugins: [react(), branchPlugin()] }); | ||
| * ``` |
Member
There was a problem hiding this comment.
Can we word this such that it gets these points across:
- It determines the global branch a user is on and the rules it uses to do this. I think wording could be more concise here.
- How does it expose it I think we should write more like "make it available to the @osdk/client via import.meta.env.BLAH"
| FOUNDRY_BRANCH_RID_ENV_VAR | ||
| ]; | ||
|
|
||
| injectedBranch = resolveBranchToInject( |
Member
There was a problem hiding this comment.
It is not really obvious how pinnedBranch is different to injectedBranch?
|
|
||
| import { normalizeGitBranch } from "@osdk/shared.branch"; | ||
|
|
||
| export function resolveBranchToInject( |
Member
There was a problem hiding this comment.
It feels strange that this file reads so similar to the ones in the shared.branch package
amishshah
approved these changes
Aug 21, 2026
amishshah
left a comment
amishshah
left a comment
Member
There was a problem hiding this comment.
Approved! I assume we're going to have to iterate on this as we test it out
| const configuredBranch = loadEnv(mode, envDir, "VITE_")[ | ||
| FOUNDRY_BRANCH_ENV_VAR | ||
| ]; | ||
| if (configuredBranch?.trim()) { |
Member
There was a problem hiding this comment.
Suggested change
| if (configuredBranch?.trim()) { | |
| if (configuredBranch?.trim() != null) { |
conventions
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
2 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