Skip to content

docs: clarify remote script folders - #1477

Merged
mrexox merged 1 commit into
evilmartians:masterfrom
scop:docs/remote-script-location
Aug 3, 2026
Merged

mrexox merged 1 commit into
evilmartians:masterfrom
scop:docs/remote-script-location

Conversation

@scop

@scop scop commented Jul 30, 2026 •

Copy link
Copy Markdown
Contributor

Closes # (issue)

Context

Changes

Note that the folders need to be in the root of the remote repository, and reword to avoid confusing two meanings of the word "scripts".

Confidence Score: 4/5

The PR is safe to merge, though the new wording should describe source_dir as relative to the remote repository root to avoid implying that nested paths are invalid.

The documentation correctly distinguishes the remote repository from the consuming repository, but its location wording is narrower than the implementationโ€™s relative-path behavior.

Files Needing Attention: docs/configuration/remotes.md

Reviews (1): Last reviewed commit: "docs: clarify remote script folders" | Re-trigger Greptile

Greptile also left 1 inline comment on this PR.

Note that the folders need to be in the root of the _remote_ repository,
and reword to avoid confusing two meanings of the word "scripts".
@scop
scop requested a review from mrexox as a code owner July 30, 2026 11:54
You can use [`extends`](./extends.md) but the paths must be relative to the remote repository root.

If you provide [`scripts`](./scripts.md) in a remote config file, the [scripts](./source_dir.md) folder must also be in the **root of the repository**.
If you provide [`scripts`](./scripts.md) in a remote config file, the [script `source_dir`](./source_dir.md) must also be in the **root of the remote repository**.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Describe the relative path behavior

The implementation resolves source_dir relative to the remote repository root and supports nested paths, while โ€œmust also be in the rootโ€ implies that only a direct child of the root is valid. Describing the resolution rule directly avoids prompting users to restructure valid remote repositories.

Suggested change
If you provide [`scripts`](./scripts.md) in a remote config file, the [script `source_dir`](./source_dir.md) must also be in the **root of the remote repository**.
If you provide [`scripts`](./scripts.md) in a remote config file, the [script `source_dir`](./source_dir.md) path is resolved relative to the **root of the remote repository**.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@mrexox mrexox 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.

Thank you for taking care!

@mrexox
mrexox merged commit 54e5ef5 into evilmartians:master Aug 3, 2026
14 of 15 checks passed
@scop
scop deleted the docs/remote-script-location branch August 3, 2026 16:03
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.

2 participants