Skip to content

Add a finalize template which causes jobs with issues to fail#17314

Merged
TravisEz13 merged 7 commits intoPowerShell:masterfrom
TravisEz13:fail-builds-for-warnings
May 11, 2022
Merged

Add a finalize template which causes jobs with issues to fail#17314
TravisEz13 merged 7 commits intoPowerShell:masterfrom
TravisEz13:fail-builds-for-warnings

Conversation

@TravisEz13
Copy link
Copy Markdown
Member

@TravisEz13 TravisEz13 commented May 11, 2022

PR Summary

Add a finalize template which causes jobs with issues to fail

Verified it works with 5b10f29:
CleanShot 2022-05-11 at 11 05 56@2x

This is what it looks like on the success path:
CleanShot 2022-05-11 at 11 08 31@2x

PR Context

the release won't work on a pipeline with issue.

PR Checklist

@TravisEz13 TravisEz13 force-pushed the fail-builds-for-warnings branch from b975712 to a55cb9c Compare May 11, 2022 17:47
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

This PR has 20 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       : +20 -0
Percentile : 8%

Total files changed: 14

Change summary by file extension:
.yml : +20 -0

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.

Copy link
Copy Markdown
Contributor

@PaulHigin PaulHigin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TravisEz13 TravisEz13 merged commit 2fe5f00 into PowerShell:master May 11, 2022
@TravisEz13 TravisEz13 deleted the fail-builds-for-warnings branch May 11, 2022 22:24
@ghost
Copy link
Copy Markdown

ghost commented May 23, 2022

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

Handy links:

@adityapatwardhan
Copy link
Copy Markdown
Member

/backport to release/v7.0.12

@adityapatwardhan
Copy link
Copy Markdown
Member

/backport to release/v7.2.5

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 24, 2022

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

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 24, 2022

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

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

@github-actions
Copy link
Copy Markdown
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: Add a finalize template
Applying: add finalize to prep
Applying: update display name
Applying: Add condition
Applying: revert me: add fake issue
Applying: fix display name
error: sha1 information is lacking or useless (tools/releaseBuild/azureDevOps/templates/checkAzureContainer.yml).
error: could not build fake ancestor
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0006 fix display name
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!

@adityapatwardhan adityapatwardhan added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Jun 16, 2022
@adityapatwardhan
Copy link
Copy Markdown
Member

/backport to release/v7.0.12

@ghost
Copy link
Copy Markdown

ghost 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-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants