Skip to content

feat: publish netlify.toml schema - #677

Merged
eduardoboucas merged 3 commits into
masterfrom
feat/netlify-toml-schema
Nov 3, 2026
Merged

eduardoboucas merged 3 commits into
masterfrom
feat/netlify-toml-schema

Conversation

@eduardoboucas

@eduardoboucas eduardoboucas commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Publishes the JSON schema for netlify.toml at https://open-api.netlify.com/netlify.schema.json, so editors can validate the file and autocomplete its properties. The schema lives in @netlify/config, added in netlify/build#7309.

Note that the diff is misleadingly large due to the format of the lock file moving from v1 to v3, but that shouldn't impact anything.

@netlify

netlify Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for open-api ready!

Name Link
🔨 Latest commit 772b706
🔍 Latest deploy log https://app.netlify.com/projects/open-api/deploys/6aea021d56a1d022e9acdd84
😎 Deploy Preview https://deploy-preview-677--open-api.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Summary

Summary by CodeRabbit

  • Chores
    • The build now includes the Netlify configuration schema in its output, making it available to tools and workflows that consume the published build.
    • Added validation for schema URLs so the build only writes schema files to supported root-level paths.

The build now runs a schema-copy script between convert and bundle. The script reads the schema from @netlify/config, validates its $id origin and path, then writes the schema to the corresponding path in dist. Tests check that the copied file matches the source and that unsupported IDs are rejected.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Suggested reviewers: paulo

Merge Risk: Minimal · up to 772b7

No concrete merge-blocking risk was found. Pinning the public URL in the test would guard against future mispublication.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

package.json

Parsing error: Unexpected token :

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.

@eduardoboucas
eduardoboucas marked this pull request as ready for review November 3, 2026 15:51
@eduardoboucas
eduardoboucas requested a review from a team as a code owner November 3, 2026 15:51
@eduardoboucas
eduardoboucas merged commit 96b6884 into master Nov 3, 2026
20 of 21 checks passed
@eduardoboucas
eduardoboucas deleted the feat/netlify-toml-schema branch November 3, 2026 15:54
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