Skip to content
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

Jump to bottom

Update feature flags doc #2063

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update feature flags doc #2063

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4416a23
Update master branch to main
saracope Oct 10, 2024
3e76474
Fixes for grammar
saracope Oct 10, 2024
97b6846
Update feature key example - closes #453
saracope Oct 10, 2024
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
22 changes: 11 additions & 11 deletions guides/release/configuring-ember/feature-flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ Ember.js community considers them ready for production use.
A newly-flagged feature is only available in canary builds and can be enabled
at runtime through your project's configuration file.

At the start of a beta cycle the Ember core team evaluates each new feature.
At the start of a beta cycle, the Ember core team evaluates each new feature.
Features deemed stable are made available in the next beta and enabled by default.

Beta features that receive negative feedback from the community are disabled in the next beta point
release, and are not included in the next stable release. They may still be included
release and are not included in the next stable release. They may still be included
in the next beta cycle if the issues/concerns are resolved.

Once the beta cycle has completed, the next stable release will include any features that
were enabled during the beta cycle. At this point the feature flags will be removed from
Once the beta cycle has been completed, the next stable release will include any features that
were enabled during the beta cycle. At this point, the feature flags will be removed from
the canary and future beta branches, and the feature becomes part of the framework.

## Flagging Details
The flag status in the generated build is controlled by the [`@ember/canary-features`](https://github.com/emberjs/ember.js/blob/master/packages/@ember/canary-features/index.ts)
The flag status in the generated build is controlled by the [`@ember/canary-features`](https://github.com/emberjs/ember.js/blob/main/packages/@ember/canary-features/index.ts)
package. This package exports a list of all available features and their current status.

A feature can have one of a three flags:
A feature can have one of three flags:

* `true` - The feature is **present** and **enabled**: the code behind the flag is always enabled in
the generated build.
Expand All @@ -36,12 +36,12 @@ A feature can have one of a three flags:
The process of removing the feature flags from the resulting build output is
handled by [`defeatureify`](https://github.com/thomasboyt/defeatureify).

## Feature Listing ([`FEATURES.md`](https://github.com/emberjs/ember.js/blob/master/FEATURES.md))
## Feature Listing ([`FEATURES.md`](https://github.com/emberjs/ember.js/blob/main/FEATURES.md))

When a developer adds a new feature to the `canary` channel (i.e. the `master` branch on GitHub), they
also add an entry to [`FEATURES.md`](https://github.com/emberjs/ember.js/blob/master/FEATURES.md)
When a developer adds a new feature to the `canary` channel (i.e. the `main` branch on GitHub), they
also add an entry to [`FEATURES.md`](https://github.com/emberjs/ember.js/blob/main/FEATURES.md)
explaining what the feature does, and linking to their originating pull request.
This list is kept current, and reflects what is available in each channel
This list is kept current and reflects what is available in each channel
(`release`, `beta`, and `canary`).

## Enabling At Runtime
Expand All @@ -52,7 +52,7 @@ feature by setting its flag value to `true` before your application boots:
let ENV = {
EmberENV: {
FEATURES: {
'link-to': true
'LINK_TO': true
}
}
};
Expand Down
Loading