changesets/action support Sparse Checkout #514
Closed
Conversation
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
## Issue Analysis: changesets/action with Sparse Checkout ### The Problem The changesets/action fails with "There is no .changeset directory in this project" when using sparse checkout, even when the `cwd` parameter is specified. ### Root Cause The error occurs during the initial validation phase of the action, before any custom commands run. Here's the code flow: 1. **In [changesets/action index.ts line 31](https://raw.githubusercontent.com/changesets/action/refs/heads/main/src/index.ts)**: ```typescript let { changesets } = await readChangesetState(); // No cwd parameter passed ``` 2. **In [readChangesetState.ts](https://raw.githubusercontent.com/changesets/action/refs/heads/main/src/readChangesetState.ts)**: ```typescript export default async function readChangesetState( cwd: string = process.cwd() // Defaults to repo root when not provided ): Promise<ChangesetState> { let preState = await readPreState(cwd); let changesets = await readChangesets(cwd); // This calls @changesets/read ``` 3. **The `readChangesets` function from `@changesets/read`** looks for `.changeset` at the provided path and throws the error when not found. ### Why This Happens - `index.ts` calls `readChangesetState()` without the `cwd` parameter - `readChangesetState` defaults to `process.cwd()` (repository root) - With sparse checkout, `.changeset` doesn't exist at the repo root - The action fails during initialization, before `version` or `publish` commands run ### Workaround Since the validation happens before our custom commands execute, we need to ensure `.changeset` exists at the repository root: ```yaml - name: Create .changeset symlink for changesets/action run: | # The changesets/action checks for .changeset at repo root during initialization # Since we're using sparse checkout, we need to create a symlink ln -s libraries/javascript/polaris/.changeset .changeset ``` ### Proper Fix The changesets/action should pass the `cwd` parameter to `readChangesetState()`: ```typescript let { changesets } = await readChangesetState(cwd); // Pass the cwd parameter ``` ```
|
alex-page
commented
Jul 23, 2025
Author
There was a problem hiding this comment.
This will be removed. Using it to test the action pointed to this commit.
Author
|
This didn't work. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The Problem
The changesets/action fails with "There is no .changeset directory in this project" when using sparse checkout, even when the
cwdparameter is specified. I am using sparse checkout to take a folder from a very large GitHub repository and this folder has it's own.changesetdirectory.Root Cause
The error occurs during the initial validation phase of the action, before any custom commands run. Here's the code flow:
1: In changesets/action index.ts we call
let { changesets } = await readChangesetState();without passing thecwdin.action/src/index.ts
Line 46 in 04d574e
2: This is passed into
readChangesetState.tswhere thecwdis set toprocess.cwd()because thecwdfrom the action is not passed through.action/src/readChangesetState.ts
Line 14 in 04d574e
readChangesetsfunction from@changesets/readlooks for.changesetat the provided path and throws the error when not found.https://github.com/changesets/changesets/blob/c7b6832a7a2783073e720d2085a546810e9b55eb/packages/read/src/index.ts#L22-L35
Why This Happens
index.tscallsreadChangesetState()without thecwdparameterreadChangesetStatedefaults toprocess.cwd()(repository root).changesetdoesn't exist at the repo rootversionorpublishcommands run