Skip to content

feat(astro-env): Allow setting descriptions on env schema config#16438

Open
empoulter-uclan wants to merge 3 commits intowithastro:mainfrom
empoulter-uclan:env-config-description
Open

feat(astro-env): Allow setting descriptions on env schema config#16438
empoulter-uclan wants to merge 3 commits intowithastro:mainfrom
empoulter-uclan:env-config-description

Conversation

@empoulter-uclan
Copy link
Copy Markdown
Contributor

Changes

  • Allows setting descriptions on env schema config
  • Useful for describing where variables come from, how to generate them, etc.
  • Description will be emitted in generated typescript definition file, for intellisense &c.

Testing

Additional config was added to a test fixture, and generated typescript definition was manually verified.

Docs

Probably could add a note in https://docs.astro.build/en/guides/environment-variables/#type-safe-environment-variables

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 21, 2026

🦋 Changeset detected

Latest commit: 3c35be6

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions Bot added the pkg: astro Related to the core `astro` package (scope) label Apr 21, 2026
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 21, 2026

Merging this PR will not alter performance

✅ 16 untouched benchmarks
⏩ 2 skipped benchmarks1


Comparing empoulter-uclan:env-config-description (3c35be6) with main (3852adc)2

Open in CodSpeed

Footnotes

  1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

  2. No successful run was found on main (8a13969) during the generation of this report, so 3852adc was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg: astro Related to the core `astro` package (scope)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant