Skip to content

chore(cxapi): reduce merge conflicts in feature flags#18411

Merged
mergify[bot] merged 5 commits intomasterfrom
huijbers/fewer-merge-conflicts
Feb 8, 2022
Merged

chore(cxapi): reduce merge conflicts in feature flags#18411
mergify[bot] merged 5 commits intomasterfrom
huijbers/fewer-merge-conflicts

Conversation

@rix0rrr
Copy link
Copy Markdown
Contributor

@rix0rrr rix0rrr commented Jan 13, 2022

Try to reduce (future) merge conflicts when feature flags are added.

It currently looks like FUTURE_FLAGS_DEFAULTS should contain all
flags, and they're all set to false. On the v2-main branch, they're
all set to true.

When adding a new flag, you want to follow suit and add a new line with
the flag default set to false; then you get a merge conflict when
merging to v2-main branch because all preceding lines will have
changed. The merge conflict alone is annoying, and you'll also be
tempted to put in true there, which would be incorrect, and be a
breaking change of behavior.

Instead, this PR gets rid of the entire set of FUTURE_FLAGS_DEFAULTS
set to false -- there's no point to having them anyway, and it
gets rid of the associated merge conflicts.

Also shore up the docs for these flags a little.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Try to reduce (future) merge conflicts when feature flags are added.

It currently looks like `FUTURE_FLAGS_DEFAULTS` should contain all
flags, and they're all set to `false`. On the `v2-main` branch, they're
all set to `true`.

When adding a new flag, you want to follow suit and add a new line with
the flag default set to `false`; then you get a merge conflict when
merging to `v2-main` branch because all preceding lines will have
changed. The merge conflict alone is annoying, and you'll also be
tempted to put in `true` there, which would be incorrect, and be a
breaking change of behavior.

Instead, this PR gets rid of the entire set of `FUTURE_FLAGS_DEFAULTS`
set to `false` -- there's no point to having them anyway, and it
gets rid of the associated merge conflicts.

Also shore up the docs for these flags a little.
@rix0rrr rix0rrr requested a review from a team January 13, 2022 16:22
@rix0rrr rix0rrr self-assigned this Jan 13, 2022
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Jan 13, 2022

@github-actions github-actions bot added the @aws-cdk/cx-api Related to the Cloud Executable API label Jan 13, 2022
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 13, 2022
@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: e084f43
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Feb 8, 2022

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit dcdb58a into master Feb 8, 2022
@mergify mergify bot deleted the huijbers/fewer-merge-conflicts branch February 8, 2022 11:08
TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
Try to reduce (future) merge conflicts when feature flags are added.

It currently looks like `FUTURE_FLAGS_DEFAULTS` should contain all
flags, and they're all set to `false`. On the `v2-main` branch, they're
all set to `true`.

When adding a new flag, you want to follow suit and add a new line with
the flag default set to `false`; then you get a merge conflict when
merging to `v2-main` branch because all preceding lines will have
changed. The merge conflict alone is annoying, and you'll also be
tempted to put in `true` there, which would be incorrect, and be a
breaking change of behavior.

Instead, this PR gets rid of the entire set of `FUTURE_FLAGS_DEFAULTS`
set to `false` -- there's no point to having them anyway, and it
gets rid of the associated merge conflicts.

Also shore up the docs for these flags a little.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@aws-cdk/cx-api Related to the Cloud Executable API contribution/core This is a PR that came from AWS.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants