Skip to content

Fix parsing SemanticVersion build label from version string - #16608

Merged
Dongbo Wang (daxian-dbw) merged 4 commits into
PowerShell:masterfrom
JoeRobich:fix-semantic-version-parse
Dec 17, 2021
Merged

Dongbo Wang (daxian-dbw) merged 4 commits into
PowerShell:masterfrom
JoeRobich:fix-semantic-version-parse

Conversation

@JoeRobich

Copy link
Copy Markdown
Contributor

PR Summary

Improve the SemanticVersion parsing logic to handle missing cases.

PR Context

Parsing semantic version strings of the form major.minor.patch+release is broken.

Here is an example from PowerShell 7.2:

~/Source> $v1 = [System.Management.Automation.SemanticVersion]::new("1.0.0+META")
MethodInvocationException: Exception calling ".ctor" with "1" argument(s): "Input string was not in a correct format."

PR Checklist

@JoeRobich Joey Robichaud (JoeRobich) changed the title Fix parsing SemanticVersion build label from verison string Fix parsing SemanticVersion build label from version string Dec 13, 2021
@JoeRobich

Copy link
Copy Markdown
Contributor Author

Ilya (@iSazonov) I believe this is ready for a review. I choose a good test case because my initial fix wasn't quite right according to the spec. Now I believe we are properly parsing the labels.

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Dec 16, 2021
@pull-request-quantifier-deprecated

Copy link
Copy Markdown

This PR has 19 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       : +18 -1
Percentile : 7.6%

Total files changed: 2

Change summary by file extension:
.cs : +4 -1
.ps1 : +14 -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.

@daxian-dbw Dongbo Wang (daxian-dbw) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 16, 2021
@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit b7ce3c5 into PowerShell:master Dec 17, 2021
@daxian-dbw

Copy link
Copy Markdown
Member

Joey Robichaud (@JoeRobich) Thanks for your contribution!

TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
@ghost

Copy link
Copy Markdown

🎉v7.3.0-preview.2 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

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants