Skip to content

Fix automation to update experimental json files in GitHub action#16837

Merged
adityapatwardhan merged 15 commits intoPowerShell:masterfrom
adityapatwardhan:GenerateExp2
Feb 4, 2022
Merged

Fix automation to update experimental json files in GitHub action#16837
adityapatwardhan merged 15 commits intoPowerShell:masterfrom
adityapatwardhan:GenerateExp2

Conversation

@adityapatwardhan
Copy link
Copy Markdown
Member

@adityapatwardhan adityapatwardhan commented Feb 3, 2022

PR Summary

Create a GitHub action to run daily and create PR for updating json files for experimental features

PR Context

PR Checklist

@ghost ghost assigned PaulHigin Feb 3, 2022
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

pull-request-quantifier-deprecated bot commented Feb 3, 2022

This PR has 92 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Small
Size       : +69 -23
Percentile : 36.8%

Total files changed: 1

Change summary by file extension:
.yml : +69 -23

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@adityapatwardhan adityapatwardhan mentioned this pull request Feb 3, 2022
Merged
@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Feb 3, 2022

for generating powershell.config.json

Why do we generate the file at all? If I understand correctly we need to explicitly turn on all experimental features in preview builds and turn off (that is default) all experimental features in release builds.
To implement this we have no needs so complicate and could implement the logic in C# code because PowerShell know whether it is preview or release version (see $PSVersionTable.PSVersion.PreReleaseLabel).

if "ExperimentalFeatures" presents in config file than process it
else if Release version than disable all experimental features
else it is preview version and we enable all all experimental features

@daxian-dbw
Copy link
Copy Markdown
Member

daxian-dbw commented Feb 3, 2022

I think @iSazonov has a good point. If we enforce this in code, then there is no need to manipulate the JSON files in our build.

@daxian-dbw
Copy link
Copy Markdown
Member

daxian-dbw commented Feb 3, 2022

There is no harm to use the pre-populated experimental feature list for now. If the code change is done in future, we can easily move away from it.

@adityapatwardhan
Copy link
Copy Markdown
Member Author

adityapatwardhan commented Feb 3, 2022

I also like the idea from @iSazonov for PS to make the decision to enable / disable. We could do that as followup. This work will unblock the issues on alpine for next preview.

@adityapatwardhan adityapatwardhan added the CL-Tools Indicates that a PR should be marked as a tools change in the Change Log label Feb 4, 2022
@adityapatwardhan adityapatwardhan merged commit ce684c3 into PowerShell:master Feb 4, 2022
@adityapatwardhan adityapatwardhan deleted the GenerateExp2 branch February 4, 2022 01:26
@iSazonov iSazonov mentioned this pull request Feb 4, 2022
Closed
22 tasks
@ghost
Copy link
Copy Markdown

ghost commented Feb 24, 2022

🎉v7.3.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

@daxian-dbw daxian-dbw mentioned this pull request Nov 7, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

@TravisEz13 TravisEz13 TravisEz13 approved these changes

@anmenaga anmenaga Awaiting requested review from anmenaga

@PaulHigin PaulHigin Awaiting requested review from PaulHigin

Assignees

@PaulHigin PaulHigin

Labels

CL-Tools Indicates that a PR should be marked as a tools change in the Change Log Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@adityapatwardhan @iSazonov @daxian-dbw @TravisEz13 @PaulHigin