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

Refresh Change Wave Docs #5770

Merged
merged 4 commits into from
Oct 6, 2020
Merged

Refresh Change Wave Docs #5770

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5f8d2ce
Refresh docs for an easier read
benvillalobos Oct 2, 2020
27da04e
fix sentence
benvillalobos Oct 2, 2020
cafcec6
PR Feedback
benvillalobos Oct 5, 2020
315b741
PR Feedback
benvillalobos Oct 5, 2020
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
6 changes: 2 additions & 4 deletions documentation/wiki/ChangeWaves-Dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
⚠ This doc is intended for internal teams.
benvillalobos marked this conversation as resolved.
Show resolved Hide resolved

# What are Change Waves?
A Change Wave is a set of risky features developed under the same opt-out flag. This flag happens to be the version of MSBuild that the features were developed for. The purpose of this is to warn developers of risky changes that will become standard functionality down the line.
benvillalobos marked this conversation as resolved.
Show resolved Hide resolved
A Change Wave is a version in which a set of risky features exists under the same opt-out flag. This flag happens to be the version of MSBuild that the features were developed for. The purpose of this is to warn developers of risky changes that will become standard functionality down the line.

## How do they work?
The opt out comes in the form of setting the environment variable `MSBuildDisableFeaturesFromVersion` to the wave (or version) that contains the feature you want **disabled**.

**Note:** If `MSBuildDisableFeaturesFromVersion` is set to `16.8`, this will **disable** all features under that `16.8` and **any further versions**.
The opt out comes in the form of setting the environment variable `MSBuildDisableFeaturesFromVersion` to the Change Wave (or version) that contains the feature you want **disabled**.
benvillalobos marked this conversation as resolved.
Show resolved Hide resolved

## What Are the Current Change Waves & Associated Features?
See the mapping of change waves to features [here](ChangeWaves.md#change-waves-&-associated-features).
Expand Down
17 changes: 9 additions & 8 deletions documentation/wiki/ChangeWaves.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# What are Change Waves?
A Change Wave is a set of risky features developed under the same opt-out flag. This flag happens to be the version of MSBuild that the features were developed for. The purpose of this is to warn developers of risky changes that will become standard functionality down the line.
A Change Wave is a version in which a set of risky features exists under the same opt-out flag. This flag happens to be the version of MSBuild that the features were developed for. The purpose of this is to warn developers of risky changes that will become standard functionality down the line.
benvillalobos marked this conversation as resolved.
Show resolved Hide resolved

## How do they work?
The opt out comes in the form of setting the environment variable `MSBuildDisableFeaturesFromVersion` to the wave (or version) that contains the feature you want **disabled**. See the mapping of change waves to features below.
The opt out comes in the form of setting the environment variable `MSBuildDisableFeaturesFromVersion` to the Change Wave (or version) that contains the feature you want **disabled**. See the mapping of change waves to features below.

**Note:** If `MSBuildDisableFeaturesFromVersion` is set to `16.8`, this will **disable** all features under that `16.8` and **any further versions**.

## MSBuildDisableFeaturesFromVersion Values
- If `MSBuildDisableFeaturesFromVersion` is not set, all change waves will **be enabled**
- If `MSBuildDisableFeaturesFromVersion` is set to some out of bounds version (see current rotation of waves below), you will be defaulted to the lowest wave. This will **disable all waves**.
- If `MSBuildDisableFeaturesFromVersion` is set to some invalid format (ex: 16x8, 17_0), all change waves will **be enabled**.
## MSBuildDisableFeaturesFromVersion Values & Outcomes
| `MSBuildDisableFeaturesFromVersion` Value | Result | Receive Warning? |
| :------------- | :---------- | :----------: |
| Unset | All Change Waves will be enabled, meaning all features behind each Change Wave will be enabled. | No |
| `16.8` (or any valid & current Change Wave) | All features behind the `16.8` and above Change Wave will be disabled . | No |
benvillalobos marked this conversation as resolved.
Show resolved Hide resolved
| Invalid Value (Invalid Change Wave, or out-of-rotation version) | You will be defaulted to the closest valid value (ascending). Ex: Setting `16.9` will default you to `16.10`. | Yes |
benvillalobos marked this conversation as resolved.
Show resolved Hide resolved
| Invalid Format (ex: `16x8`, `17_0`, `garbage`) | All waves will be enabled. | Yes |

# Change Waves & Associated Features

Expand Down