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.

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

Switch to using GitHub action to verify PRs for broken markdown links #17281

Merged
merged 5 commits into from May 9, 2022

Conversation

TravisEz13
Copy link
Member

@TravisEz13 TravisEz13 commented May 6, 2022

PR Summary

Switch to using GitHub action to verify PRs for broken markdown links

PR Context

The action supports only verifying changed files.
Alive status codes come from the existing code here:

$allowedFailures = [System.Net.HttpStatusCode[]](

PR Checklist

@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Small
Size       : +21 -13
Percentile : 13.6%

Total files changed: 4

Change summary by file extension:
.json : +1 -0
.yml : +19 -12
.md : +1 -1

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.

@daxian-dbw
Copy link
Member

Just curious, what is the gain by switching to GitHub action?

@TravisEz13
Copy link
Member Author

See PR Context, we will only verify changed files.

@daxian-dbw daxian-dbw merged commit 4af204f into master May 9, 2022
@daxian-dbw daxian-dbw deleted the markdown-link-pr branch May 9, 2022 18:42
@msftbot
Copy link

msftbot bot commented May 23, 2022

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

Handy links:

@adityapatwardhan
Copy link
Member

/backport to release/v7.0.12

@adityapatwardhan
Copy link
Member

/backport to release/v7.2.5

@github-actions
Copy link
Contributor

github-actions bot commented May 24, 2022

Started backporting to release/v7.0.12: https://github.com/PowerShell/PowerShell/actions/runs/2380457950

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@github-actions
Copy link
Contributor

github-actions bot commented May 24, 2022

Started backporting to release/v7.2.5: https://github.com/PowerShell/PowerShell/actions/runs/2380458722

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@github-actions
Copy link
Contributor

@adityapatwardhan backporting to release/v7.2.5 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: switch to using github action to verify PRs for markdown links
Using index info to reconstruct a base tree...
M	.vsts-ci/misc-analysis.yml
Falling back to patching base and 3-way merge...
Auto-merging .vsts-ci/misc-analysis.yml
CONFLICT (content): Merge conflict in .vsts-ci/misc-analysis.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 switch to using github action to verify PRs for markdown links
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions
Copy link
Contributor

@adityapatwardhan backporting to release/v7.0.12 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: switch to using github action to verify PRs for markdown links
Using index info to reconstruct a base tree...
M	.vsts-ci/misc-analysis.yml
Falling back to patching base and 3-way merge...
Auto-merging .vsts-ci/misc-analysis.yml
CONFLICT (content): Merge conflict in .vsts-ci/misc-analysis.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 switch to using github action to verify PRs for markdown links
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@TravisEz13
Copy link
Member Author

ported to 7.2 7249200

@TravisEz13 TravisEz13 mentioned this pull request Jun 7, 2022
22 tasks
@adityapatwardhan adityapatwardhan added the CL-Test Indicates that a PR should be marked as a test change in the Change Log label Jun 16, 2022
@msftbot
Copy link

msftbot bot commented Jun 21, 2022

🎉v7.2.5 has been released which incorporates this pull request.:tada:

Handy links:

@msftbot
Copy link

msftbot bot commented Aug 11, 2022

🎉v7.0.12 has been released which incorporates this pull request.:tada:

Handy links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport-7.0.x-Done Backport-7.2.x-Done CL-Test Indicates that a PR should be marked as a test change in the Change Log Extra Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants