Skip to content

Commit bb9c607

Browse files
Add section in readme for feature flags (#978)
* Add a section in README.md to explain the available feature flags and how to enable them * Add env variable configuration for extended domain information
1 parent 43106fc commit bb9c607

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,17 @@ CADENCE_GRPC_SERVICES_NAMES=cadence-frontend-cluster0,cadence-frontend-cluster1
3232
CADENCE_CLUSTERS_NAMES=cluster0,cluster1
3333
```
3434

35+
#### Feature flags
36+
37+
Feature flags control various UI features and functionality in `cadence-web`. These can be configured using environment variables.
38+
39+
| Feature | Description | Environment Variable Configuration | Minimum Cadence server Version |
40+
|---------|-------------|---------------------|------------------------|
41+
| Extended Domain Information | Enhanced domain metadata display and help menu UI | `CADENCE_EXTENDED_DOMAIN_INFO_METADATA_ENABLED=true` | N/A |
42+
| Workflow Diagnostics | Workflow diagnostics APIs and UI for debugging workflows | `CADENCE_WORKFLOW_DIAGNOSTICS_ENABLED=true` | 1.2.13+ (1.3.1+ for full functionality) |
43+
44+
**Note:** For advanced customization, feature flags can be modified through resolvers in the dynamic config system ([`src/config/dynamic/resolvers`](src/config/dynamic/resolvers)).
45+
3546
### Using cadence-web
3647

3748
The latest version of `cadence-web` is included in the `cadence` composed docker containers in the [main Cadence repository][cadence]. Follow the instructions there to get started.

src/config/dynamic/resolvers/extended-domain-info-enabled.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ import { type ExtendedDomainInfoEnabledConfig } from './extended-domain-info-ena
22

33
export default async function extendedDomainInfoEnabled(): Promise<ExtendedDomainInfoEnabledConfig> {
44
return {
5-
metadata: false,
5+
// TODO: @adhitya.mamallan - clean up this feature flag
6+
metadata:
7+
process.env.CADENCE_EXTENDED_DOMAIN_INFO_METADATA_ENABLED === 'true',
8+
// Unused feature flag
69
issues: false,
710
};
811
}

0 commit comments

Comments
 (0)