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

Release 1.3.0 #17

Merged
merged 22 commits into from
Dec 7, 2021
Merged

Release 1.3.0 #17

merged 22 commits into from
Dec 7, 2021

Conversation

tuplle
Copy link
Member

@tuplle tuplle commented Dec 7, 2021

Description

The release of v1.3.0 mainly updates the library to the new release of Petriflow 1.0.1.

Fixes PF-14
Implementts PF-11, PF-13, PF-16

Third-party dependencies

No new dependencies were introduced

How Has Been This Tested?

Manual developer testing has been conducted and unit testing.

Test Configuration

NodeJS 12
Windows, Linux
Jest (with JSDom)

mazarijuraj and others added 20 commits November 15, 2021 15:17
- add functions
- update test and model
- added import of new tag userRef
- modified import and implemented export of new 'userRef' tag
- implemented export and import of assign attribute
- fix validation getter/setter methods
- added import and export of anonymousRole
- modified tests
- added import of new tag userRef
- modified import and implemented export of new 'userRef' tag
- implemented export and import of assign attribute
[PF-14] Data validation getter/setter
[PF-13] Clean up petriflow schema
 - resolved PR comments
[PF-11] Update TS library
@tuplle tuplle added Bugfix Fixing something that isn't working Improvement Improvement of an existing functionality Release PR that after merge is released as a new version labels Dec 7, 2021
@tuplle tuplle self-assigned this Dec 7, 2021
@tuplle tuplle requested a review from minop December 7, 2021 12:23
 - update changelog
 - update docs
@sonarcloud
Copy link

sonarcloud bot commented Dec 7, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 5 Code Smells

87.4% 87.4% Coverage
0.0% 0.0% Duplication

@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Large
Size       : +273 -131
Percentile : 80.13%

Total files changed: 78

Change summary by file extension:
.md : +8 -1
.html : +62 -60
.json : +1 -1
.ts : +131 -54
.js : +44 -15
.xml : +27 -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.

@tuplle tuplle merged commit d9fa688 into master Dec 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bugfix Fixing something that isn't working Extra Large Improvement Improvement of an existing functionality Release PR that after merge is released as a new version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants