Skip to content

Bump base version to 3.4#198

Merged
joroKr21 merged 1 commit into
typelevel:mainfrom
armanbilge:patch-1
Jan 10, 2024
Merged

Bump base version to 3.4#198
joroKr21 merged 1 commit into
typelevel:mainfrom
armanbilge:patch-1

Conversation

@armanbilge

@armanbilge armanbilge commented Jan 10, 2024

Copy link
Copy Markdown
Member

Best practice is to bump the base version in the PR that makes the changes that require the bump in the next release :)

Unfortunately we cannot enforce this automatically since we are lacking a good way to check forward-binary-compatibility.

@joroKr21 joroKr21 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

How can we bump the base version before it's released? 🤔

@armanbilge

armanbilge commented Jan 10, 2024

Copy link
Copy Markdown
Member Author

You literally just bump it, exactly like I did in this PR :)

For example, in the Cats Effect PR that introduced the polling system, we bumped the base version to 3.6. But we have not yet released Cats Effect v3.6.0.

@joroKr21

Copy link
Copy Markdown
Member

Best practice is to bump the base version in the PR that makes the changes that require the bump in the next release :)

The moment I realise if a minor version bump is needed is when GitHub generates the release notes for me 😝

@armanbilge

Copy link
Copy Markdown
Member Author

Well, it depends what versioning strategy you are following. Under the "strict best practice" basically anything that is not a bug fix / optimization warrants a bump of the minor version.

@joroKr21

Copy link
Copy Markdown
Member

For example, in the Cats Effect PR that introduced the polling system, we bumped the base version to 3.6. But we have not yet released Cats Effect v3.6.0.

Dunno, it sounds very confusing. I guess the name doesn't really speak to me. When I see tlBaseVersion it sounds like the previous release. But it should in fact be the current one. I will try to remember 👍

@joroKr21 joroKr21 merged commit 74fbfef into typelevel:main Jan 10, 2024
@joroKr21

Copy link
Copy Markdown
Member

Well, it depends what versioning strategy you are following. Under the "strict best practice" basically anything that is not a bug fix / optimization warrants a bump of the minor version.

In this case it was Scala 3.2 -> 3.3 bump

@armanbilge

Copy link
Copy Markdown
Member Author

Further reading: https://typelevel.org/sbt-typelevel/faq.html#what-is-a-base-version-anyway

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.

2 participants