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.

Sign up for GitHub

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

Jump to bottom

Bump Version of Package #358

Merged
merged 2 commits into from
Jul 28, 2021
Merged

Bump Version of Package #358

merged 2 commits into from
Jul 28, 2021

Conversation

fchorney
Copy link
Collaborator

@fchorney fchorney commented Jul 21, 2021 •
edited

It seems typical to bump the package version when adding dependency compat values. I have set this to false by default but if we want it true by default I can change it.

If the package is >= 1.0 then the minor value will be bumped and the patch will go to 0. If the package is < 1.0 then only the patch value will be bumped.

I had a request to ignore the bumping of version values if a pre-release strings exists in the version number such as -DEV. Let me know if this needs to be relaxed or if we want a different rule for it.

Note: This was made against the v3-dev branch.

closes #132

@fchorney fchorney changed the base branch from master to v3-dev July 21, 2021 20:33
@fchorney
Copy link
Collaborator Author

bors try

bors bot added a commit that referenced this pull request Jul 21, 2021
@bors
Try #358:
ee69bf7
@bors
Copy link
Contributor

bors bot commented Jul 21, 2021

try

Build succeeded:

@DilumAluthge
Copy link
Member

I have set this to false by default but if we want it true

Yeah I think false by default is good.

Would it make sense to just always bump the patch version? I don't think a compat bump needs a minor version bump in a post 1.0 packages, does it?

@fchorney
Copy link
Collaborator Author

Would it make sense to just always bump the patch version? I don't think a compat bump needs a minor version bump in a post 1.0 packages, does it?

According to ColPrac it seems that it should. It has this section about changing compat entries:

Changing dependency compatibility

  • Generally changing dependency compatibility should be a non-breaking feature.
    • i.e. pre-1.0 change patch version number, post-1.0 change the minor version number.
    • For instance, adding or removing compatibility with a particular version of a current dependency, which may or may not require internal code changes.
    • This also applies when adding or removing packages as dependencies.
    • The new feature in question is the ability to use with a different set of packages.
  • Changing a dependency to resolve a bug is a bug-fix.
    • i.e. pre/post-1.0 change patch version number.
    • For instance, if a bug in a downstream dependency is causing a problem in your package restricting compat to not allow that version would be a bug-fix.
  • Changing compatibility with dependencies may be a breaking release, if it breaks the user-facing interface.
    That is to say if the dependency’s API leaks into your API.
    There are three ways that this can happen:
    • Reexporting a function that has changed.
    • Returning an object of a type that’s behaviour has changed.
    • Subtyping an object that has changed.

@fchorney
Copy link
Collaborator Author

bors try

bors bot added a commit that referenced this pull request Jul 22, 2021
@bors
Try #358:
82e5bf6
@bors
Copy link
Contributor

bors bot commented Jul 22, 2021

try

Build failed:

@fchorney
Copy link
Collaborator Author

bors try

bors bot added a commit that referenced this pull request Jul 22, 2021
@bors
Try #358:
63180c9
@bors
Copy link
Contributor

bors bot commented Jul 22, 2021

try

Build succeeded:

@DilumAluthge
Copy link
Member

I had a request to ignore the bumping of version values if a pre-release strings exists in the version number such as -DEV.

I think this rule sounds good.

@fchorney
Copy link
Collaborator Author

Any other comments or does this seem good to go?

@fchorney
Copy link
Collaborator Author

bors r+

@bors
Copy link
Contributor

bors bot commented Jul 28, 2021

Build succeeded:

@bors bors bot merged commit 739aff6 into v3-dev Jul 28, 2021
@bors bors bot deleted the fc/bump-version branch July 28, 2021 14:38
@st-- st-- mentioned this pull request Aug 11, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattBrzezinski mattBrzezinski mattBrzezinski approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Opt-in feature: bump patch component of version number
3 participants
@fchorney @DilumAluthge @mattBrzezinski