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

refactor(main)!: moves optional parameters to the options - BREAKING #44

Merged
merged 2 commits into from
Feb 21, 2024

Conversation

sverweij
Copy link
Owner

@sverweij sverweij commented Feb 21, 2024

Description

  • removes the optional pOldRevision and pNewRevision parameters from the main function
  • adds oldRevision and newRevision attributes to the options object passed to the main function that have the same function as the removed parameters.

Motivation and Context

This makes the interface less klunky to use - the parameters were both optional and either one could be passed, which would result in calls with the parameters that aren't relevant in the context as null like main(null, "somebranch") or main("develop", null {trackedOnly: true}).

How Has This Been Tested?

  • green ci
  • updated automated non-regression tests

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation only change
  • Refactor (non-breaking change which fixes an issue without changing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • 📖

    • My change doesn't require a documentation update, or ...
    • it does and I have updated it
  • ⚖️

    • The contribution will be subject to The MIT license, and I'm OK with that.
    • The contribution is my own original work.
    • I am ok with the stuff in CONTRIBUTING.md.

@sverweij sverweij merged commit 392a0ca into main Feb 21, 2024
4 checks passed
@sverweij sverweij deleted the feature/rationalize-main-interface branch February 21, 2024 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant