Skip to content

chore: Updating feature flag doc #8314

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.

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
16 changes: 14 additions & 2 deletions docs/internal/FeatureFlags.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,20 @@ Feature flag state not yet surfaced to extensions.
Non hidden feature flags are toggleable through the app settings page in Composer. Hidden feature flags can be configured by the end user in a few different ways depending on your environment.

### Electron app
Currently no way yet to set feature flags in downloaded electron app

To toggle a hidden feature flag in electron you need to set the feature flag value as an environment variable in a command line and then open Composer through that same command line.
#### Windows
- Open a command line
- Navigate to where your electron executable is stored.
- Default location on Windows machines is `C:\Users\{user}\AppData\Local\Programs\Bot Framework Composer`
- Default location on mac is `/Applications/Bot Framework Composer.app/Contents/MacOS`
- sample command: `cd C:\Users\{user}\AppData\Local\Programs\Bot Framework Composer`
- In the command line set the value of the hidden feautre flag you would like to enable.
- For example, if you want to enable the ADVANCED_TEMPLATE_OPTIONS feature flag you would run the following sample command in the command line
- sample command on widnows:`set ADVANCED_TEMPLATE_OPTIONS=true`
- sample command on mac: `ADVANCED_TEMPLATE_OPTIONS=true ./Bot\ Framework\ Composer`
- Then in the Composer dir run the Composer executable and it should open Composer with that hidden feature flag enabled
- sample command: `"Bot Framework Composer.exe"`

### Dev env
Feature flag values are stored in data.json. In a development environment where you have direct access to this file you can toggle the value for hidden and non hidden feature flags directly in data.json.
Next iteration task items:
Expand Down