[Docs] Document git:directory resource options#3179
Merged
Conversation
Adds documentation explaining how to override the auto-generated folder name when installing plugins/themes from git repositories.
Adds refType to the type definition and explains that it's required when using branch or tag names (HEAD works without it).
fellyph
reviewed
Jan 26, 2026
| - This resource can be used with steps like [`installPlugin`](/blueprints/steps#InstallPluginStep) and [`installTheme`](/blueprints/steps#InstallThemeStep). | ||
| - Set `".git": true` to include a `.git` folder containing packfiles and refs so Git-aware tooling can detect the checkout. This currently mirrors a shallow clone of the selected ref. | ||
| - When using a branch or tag name for `ref`, you must specify `refType` (e.g. `"refType": "branch"`). Without it, only `HEAD` is reliably resolved. | ||
| - Playground automatically detects providers like GitHub and GitLab. |
Member
Author
There was a problem hiding this comment.
I didn't change this, it was just moved further down. I believe so.
Collaborator
There was a problem hiding this comment.
Perfect. I will test it to double-check.
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.
Motivation for the change, related issues
When using
git:directoryresources, the auto-generated folder name is a sanitized URL (e.g.https-github.com-owner-repo-branch-at-path), which is often undesirable. Also, using branch or tag names forrefrequires specifyingrefType, but this wasn't documented.Implementation details
refTypeto the type definition with valid values:'branch' | 'tag' | 'commit'refTypeis required when using branch or tag names (onlyHEADworks without it)options.targetFolderNameto override the folder nametargetFolderNamein useTesting Instructions (or ideally a Blueprint)
Preview the docs site and verify the GitDirectoryReference section at
/blueprints/steps/resources/#gitdirectoryreferencerenders correctly.