Skip to content

Say that each version stores spacefast.config.ts and who can read it - #136

Open
batuhan wants to merge 2 commits into
mainfrom
config-source-stored
Open

batuhan wants to merge 2 commits into
mainfrom
config-source-stored

Conversation

@batuhan

@batuhan batuhan commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Each version now stores the author's spacefast.config.ts as .spacefast/config-source.ts (spacefast/monorepo#5641). The team can read it with the version's files, and anyone can once the Space's source is available. This adds that to "How the TypeScript config ships" on the config reference page, with the advice to keep tokens and internal URLs out of the file and the one-time sf publish warning (spacefast/monorepo#5650).

Merge after spacefast/monorepo#5650 so the page describes shipped behavior.

🤖 Generated with Claude Code


Run Proof
Open in [code]smith · Need help on this PR? Tag @codesmith-bot with what you need.

Summary by CodeRabbit

  • Documentation
    • Clarified that publishing with spacefast.config.ts stores a copy with each version, where it can be read through version files but is not served.
    • Documented the one-time warning on the first publish when source is available, and advised keeping tokens and internal URLs out of the config.

@indent

indent Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Issues

All clear! No issues remaining. 🎉

1 issue already resolved
  • The new paragraph says that with source available "anyone can read it in the public source", where "it" is the version's stored .spacefast/config-source.ts. Source availability shares the Space's Git main branch, so anyone can read only the spacefast.config.ts committed there. Version files never reach that repo. (fixed by commit d9acf38)
    Found by Indent Review Agent

CI Checks

All required CI checks passed on d9acf38.

Review agents

Select any unchecked box below to run or rerun that agent.

Passed (1)
  • Indent Review Agent · No issues found in the current wording
Full results

Indent Review Agent

  • Summary: No issues found in the current wording
  • Last ran on commit: d9acf388
  • Latest result
    {
      "summary": "No issues found in the current wording",
      "findings": []
    }

@coderabbitai

coderabbitai Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Explain Change →

Warning

Review limit reached

Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab.

Next included review available in 5 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available. Your 103 included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b5841f45-e6f9-4508-9690-77574657c664
Commits

Reviewing files that changed from the base of the PR and between f4efe4a and d9acf38.

Files selected for processing: 1

  • content/(reference)/config-file.mdx

No actionable comments were generated in the recent review.

Walkthrough

The documentation now describes the config source copy stored with each version, its visibility, a one-time publish warning, and guidance to keep tokens and internal URLs out of the config.

Changes: Config source publishing

Layer / File(s) Summary
Document config source copy
content/(reference)/config-file.mdx
The documentation explains where the config source copy is stored, how it can be read, when it is public, and what to keep out of the config.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: alexanderaidun-a8c

Merge Risk: Minimal · previous review f4efe

This change only adds documentation about the stored config source copy, who can read it, and a first-publish warning. No runtime behavior changes. Authors may want clearer wording on how to supply tokens and internal URLs to the config, but this is not a merge blocker.

Architecture risk: Low · up to f4efe

The change affects 1 system.

Changed systems: content

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — content (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in content/(reference)/config-file.mdx: The TypeScript-config shipping documentation now says the version includes the source config at .spacefast/config-source.ts; it is not served, is readable through version files, and is public when the Space’s source is available. It also documents a one-time warning on the first sf publish with source available and advises keeping tokens and internal URLs out of the file.
Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title states that each version stores spacefast.config.ts and specifies who can read it. The change adds two documentation lines to the config reference page saying each version stores the config …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title states that each version stores spacefast.config.ts and specifies who can read it. The change adds two documentation lines to the config reference page saying each version stores the config as .spacefast/config-source.ts, that it can be read through version files, and that it is publicly readable once the Space's source is available. The title matches the main change and is specific enough for a teammate scanning history.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2bb01cec-233a-456f-92d1-08f347f70766
Commits

Reviewing files that changed from the base of the PR and between dab9c69 and f4efe4a.

Files selected for processing: 1

  • content/(reference)/config-file.mdx

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Comment thread content/(reference)/config-file.mdx Resolved

This branch was successfully deployed

1 active deployment
preview/config-source-stored — d9acf388 Deployed Nov 15, 2026 by spacefast[bot]
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.

1 participant