PowerShell
WIP: Devcontainer updates and support codespaces
PR Summary
This provides several updates with the goal of enabling a PowerShell contributor to begin contributing as fast as possible to PowerShell utilizing a devcontainer or CodeSpaces and Visual Studio Code.
- Update devcontainer base OS to official vscode Ubuntu 18.04 devcontainer image
- Add devcontainer tooling and initial setup scripts to match the docs/building/linux.md document as closely as possible
- Add setup steps mirrored from the codespaces devcontainer repo to ensure proper codespaces support
- Remove legacy Fedora references that are no longer reference in the codebase or Azure Pipelines AFAIK
Known Issues
- Codespaces doesnt support
WaitForon the creation commands yet, so occasionally a race condition occurs where omnisharp loads before dotnet has been bootstrapped byStart-PSBootstrap, leading to a dotnet not found message. This can be resolved by just reloading the window. I can also suppress the message but I chose not to as it seems to be fairly rare. Oncewaitforis supported then this won't be an issue
PR Context
PR Checklist
- [x] PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
- [x] Summarized changes
- [x] Make sure all
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright header - [ ] This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix
WIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.
- If the PR is work in progress, please add the prefix
-
Breaking changes
- [x] None
- OR
- [ ] Experimental feature(s) needed
- [ ] Experimental feature name(s):
-
User-facing changes
- [x] Not Applicable
- OR
- [ ] Documentation needed
- [ ] Issue filed:
-
Testing - New and feature
- [x] N/A or can only be tested interactively
- OR
- [ ] Make sure you've added a new test if existing tests do not effectively test the code changed
-
Tooling
- [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- [ ] I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
- [ ] Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
(which runs in a different PS Host).
- [ ] Issue filed:
- [ ] Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
- [ ] Issue filed:
- [ ] Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
- [ ] Issue filed:
- [ ] Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
- [ ] Issue filed:
- [ ] Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
(which runs in a different PS Host).
This PR has 154 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!
Quantification details
Label : Medium
Size : +97 -57
Percentile : 50.8%
Total files changed: 13
Change summary by file extension:
.json : +73 -25
.ps1 : +22 -3
.gitignore : +2 -1
.devcontainer/Dockerfile : +0 -20
.devcontainer/fedora30/Dockerfile : +0 -8
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
Excludedsection from yourprquantifier.yamlcontext profile. - Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your
prquantifier.yamlcontext profile. - Only use the labels that matter to you, see context specification to customize your
prquantifier.yamlcontext 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).
- For PRs that fall outside of the desired spectrum, review the details and check if:
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? :thumbsup: :ok_hand: :thumbsdown: (Email) Customize PullRequestQuantifier for this repository.
![pull-request-quantifier-deprecated[bot] avatar](https://avatars.githubusercontent.com/in/93966?v=4 "Published by a pub.dev verified publisher"){kind=small}
This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.
![msftbot[bot] avatar](https://avatars.githubusercontent.com/in/26612?v=4 "Published by a pub.dev verified publisher"){kind=small}
Maybe include <EnableWindowsTargeting>true</EnableWindowsTargeting> per project or in a Directory.Build.props in the root so we can compile for Windows. Had to use that to catch all errors in #17769.
@fflaten I don't think windows containers are supported for either devcontainers or codespaces?
@fflaten I don't think windows containers are supported for either devcontainers or codespaces?
Not Windows containers, but being able to run Start-PSBuild -Runtime win7-x64 in Ubuntu container. Without that property it won't download the required Windows targeting packs. See https://docs.microsoft.com/en-us/dotnet/core/tools/sdk-errors/netsdk1100
Learn about the .NET SDK error message that instructs you to set the EnableWindowsTargeting property to true.
This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.
This PR has 154 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!
Quantification details
Label : Medium
Size : +97 -57
Percentile : 50.8%
Total files changed: 13
Change summary by file extension:
.json : +73 -25
.ps1 : +22 -3
.gitignore : +2 -1
.devcontainer/Dockerfile : +0 -20
.devcontainer/fedora30/Dockerfile : +0 -8
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 detected.
- 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
Excludedsection from yourprquantifier.yamlcontext profile. - Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your
prquantifier.yamlcontext profile. - Only use the labels that matter to you, see context specification to customize your
prquantifier.yamlcontext 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).
- For PRs that fall outside of the desired spectrum, review the details and check if:
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? :thumbsup: :ok_hand: :thumbsdown: (Email) Customize PullRequestQuantifier for this repository.
This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.
@SeeminglyScience I'm going to let this go dormant but I do plan to still finish it, when I do I'll ask you to reopen it.
@SteveL-MSFT have some time to investigate this again. Question: Prebuilds now use Github Actions, and are stored in Github storage. These have a free allocation now for public repos, as such will this be possible to do now?