Skip to content

Add environments documentation guide#705

Merged
IEvangelist merged 3 commits intomainfrom
docs/environments-guide
Apr 14, 2026
Merged

Add environments documentation guide#705
IEvangelist merged 3 commits intomainfrom
docs/environments-guide

Conversation

@davidfowl
Copy link
Copy Markdown
Contributor

@davidfowl davidfowl commented Apr 12, 2026 •
edited
Loading

Summary

Adds deployment docs for Aspire environments and updates related deployment guides so environment-specific behavior is easier to discover.

New page: /deployment/environments/

  • Explains the Aspire environment as an AppHost concept
  • Shows how to pass environment names to the AppHost for local start and deployment commands
  • Shows how to read the environment in C# and TypeScript AppHosts
  • Covers common patterns for:
    • setting runtime environment variables on child resources
    • parameter resolution and per-environment values
    • using execution context for run vs publish decisions
    • mapping GitHub Environments to Aspire environments

Updated: /deployment/azure/azure-developer-cli/

  • Clarifies that azd env select does not automatically set DOTNET_ENVIRONMENT
  • Clarifies the difference between Aspire parameters and azd infrastructure inputs

Updated: /deployment/docker-compose/

  • Adds multi-environment deployment guidance
  • Adds a command-reference link for aspire do prepare-* steps

Sidebar

  • Adds Environments to the Deployment section

Copilot AI review requested due to automatic review settings April 12, 2026 21:48
@davidfowl davidfowl requested a review from IEvangelist as a code owner April 12, 2026 21:48
Copilot AI reviewed Apr 12, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

IEvangelist
IEvangelist reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
Comment thread src/frontend/src/content/docs/deployment/docker-compose.mdx
```bash title="Deploy to production"
aspire deploy --environment production
```

Copy link
Copy Markdown
Member

@IEvangelist IEvangelist Apr 13, 2026

Choose a reason for hiding this comment

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

Include LearnMore command ref link here.

Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
Comment thread src/frontend/src/content/docs/deployment/environments.mdx

## Environments in CI/CD

In a CI/CD pipeline, you typically pass the environment name as part of the deployment command. Many CI systems have their own environment concepts that map naturally to Aspire environments.
Copy link
Copy Markdown
Member

@IEvangelist IEvangelist Apr 13, 2026

Choose a reason for hiding this comment

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

We have content on GH CI/CD elsewhere, please be sure to cross-ref link where appropriate to make related content discoverable.

eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread .github/workflows/frontend-build.yml Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/azure/azure-developer-cli.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx Outdated
eerhardt
eerhardt reviewed Apr 13, 2026
View reviewed changes
Comment thread src/frontend/src/content/docs/deployment/environments.mdx
</TabItem>
</Tabs>

## Environments in CI/CD
Copy link
Copy Markdown
Member

@eerhardt eerhardt Apr 13, 2026

Choose a reason for hiding this comment

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

Is this duplicated with the section above? #### Providing parameters in CI/CD

@IEvangelist IEvangelist mentioned this pull request Apr 13, 2026
Merged
@davidfowl davidfowl force-pushed the docs/environments-guide branch 2 times, most recently from c1d8b35 to be6acdb Compare April 13, 2026 17:19
@IEvangelist IEvangelist mentioned this pull request Apr 13, 2026
Merged
@davidfowl
Add environments documentation guide
e9126a6 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@davidfowl davidfowl force-pushed the docs/environments-guide branch from be6acdb to e9126a6 Compare April 13, 2026 22:44
@davidfowl
Force Lunaria builds out of shallow mode
d0e0643 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist IEvangelist reopened this Apr 14, 2026
@davidfowl
Fix Lunaria shallow fallback for i18n
00c7f4c 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist IEvangelist merged commit 257b107 into main Apr 14, 2026
5 checks passed
@IEvangelist IEvangelist deleted the docs/environments-guide branch April 14, 2026 03:37
JamesNK pushed a commit that referenced this pull request Apr 16, 2026
@davidfowl @JamesNK
Add environments documentation guide (#705)
600c3e7 
* Add environments documentation guide

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Force Lunaria builds out of shallow mode

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix Lunaria shallow fallback for i18n

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JamesNK pushed a commit that referenced this pull request Apr 21, 2026
@davidfowl @JamesNK
Add environments documentation guide (#705)
f489a05 
* Add environments documentation guide

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Force Lunaria builds out of shallow mode

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix Lunaria shallow fallback for i18n

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@IEvangelist IEvangelist IEvangelist approved these changes

@eerhardt eerhardt eerhardt approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@davidfowl @IEvangelist @eerhardt