Skip to content

[docs] Unify experimental polyglot AppHost feature keys #1771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
aspire-repo-bot wants to merge 1 commit into from
Closed

[docs] Unify experimental polyglot AppHost feature keys #1771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/frontend/src/content/docs/integrations/frameworks/go/go-host.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ await builder.build().run();
The `Aspire.Hosting.Go` integration can be used from C# and TypeScript AppHosts. Aspire also includes experimental Go AppHost and Go starter template support in the Aspire CLI. The Go AppHost templates use experimental Go AppHost APIs instead of the `Aspire.Hosting.Go` package. To enable Go AppHost language support for CLI templates, enable the Go feature flag:

```bash title="Aspire CLI"
aspire config set features:experimentalPolyglot:go true --global
aspire config set features.experimentalPolyglotGo true --global
```

After enabling the feature, you can create a Go starter app with:
Expand Down
5 changes: 2 additions & 3 deletions src/frontend/src/content/docs/reference/cli/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,7 @@ CLI supports.
```

3. Use `--global` (or `-g`) when you want the feature enabled by default across projects.
Copy the key name exactly from `aspire config list --all` because some
language-specific flags use a `:<language>` suffix:
Copy the key name exactly from `aspire config list --all`:

```bash title="Enable a user-scoped preview feature default"
aspire config set features.<featureKey> true --global
Expand All @@ -182,7 +181,7 @@ CLI supports.
For example, consider the following that enables global support for Go:

```bash title="Enable global Go support"
aspire config set features:experimentalPolyglot:go true --global
aspire config set features.experimentalPolyglotGo true --global
```

4. Turn a feature off by setting it to `false`, or remove the override with
Expand Down
8 changes: 4 additions & 4 deletions src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ title: Config Settings Table
| `certificates.nssDbPaths` | `certificates.nssDbPaths` | NSS database paths used for browser certificate trust on Linux. Separate paths with the platform path separator. Prefix a path with `firefox=` or `chromium=` to apply the trust settings expected by that browser family. Takes precedence over the upstream `DOTNET_DEV_CERTS_NSSDB_PATHS` environment variable. |
| `channel` | `channel` | Default Aspire channel used by channel-aware commands such as `aspire new`, `aspire init`, and `aspire update`. |
| `features.defaultWatchEnabled` | `features.defaultWatchEnabled` | Enable or disable watch mode by default when running Aspire applications for automatic restarts on file changes. |
| `features.experimentalPolyglot:go` | `features.experimentalPolyglot:go` | Enable or disable experimental Go AppHost support. |
| `features.experimentalPolyglot:java` | `features.experimentalPolyglot:java` | Enable or disable experimental Java AppHost support. |
| `features.experimentalPolyglot:python` | `features.experimentalPolyglot:python` | Enable or disable experimental Python AppHost support. |
| `features.experimentalPolyglot:rust` | `features.experimentalPolyglot:rust` | Enable or disable experimental Rust AppHost support. |
| `features.experimentalPolyglotGo` | `features.experimentalPolyglotGo` | Enable or disable experimental Go AppHost support. |
| `features.experimentalPolyglotJava` | `features.experimentalPolyglotJava` | Enable or disable experimental Java AppHost support. |
| `features.experimentalPolyglotPython` | `features.experimentalPolyglotPython` | Enable or disable experimental Python AppHost support. |
| `features.experimentalPolyglotRust` | `features.experimentalPolyglotRust` | Enable or disable experimental Rust AppHost support. |
| `features.polyglotIntegrationFilterEnabled` | `features.polyglotIntegrationFilterEnabled` | Enable or disable filtering `aspire add`, `aspire integration list`, and `aspire integration search` results to only integrations compatible with a non-C# AppHost. Disabled by default because remote NuGet feeds don't reliably answer the `tags:polyglot` query used to build the compatibility allow-list. |
| `features.showAllTemplates` | `features.showAllTemplates` | Show all available templates, including experimental ones, in `aspire new` and `aspire init`. |
| `features.showDeprecatedPackages` | `features.showDeprecatedPackages` | Show or hide deprecated packages in `aspire add` search results. |
Expand Down
Loading