search

rwijtvliet / portfolyo

Handling timeseries for power and gas retail portfolios.
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

feat: bump version to latest release +1 #69

Closed stefankeidel closed 9 months ago

stefankeidel commented 9 months ago

It seems that the release pipeline failed because while new tags were created, you forgot to bump the poetry version. The way CI is currently set up in your repo, you will have to do that by hand still (poetry version major|minor|patch)

:books: Documentation preview :books:: https://portfolyo--69.org.readthedocs.build/en/69/

rwijtvliet commented 9 months ago

Ah thanks for checking that!

Let's walk through it. I have branch main in a state I want to publish. Then I do poetry version patch in that branch, locally. But I cannot push to the main branch, so I create a new branch, and merge that into develop via pull request, and then that into main via pull request? Seems really convoluted...

I'll give you a call tomorrow, maybe we can walk through it together.

Thanks!

Ruud

On Wed, 6 Dec 2023, 15:13 Stefan Keidel, @.***> wrote:

It seems that the release pipeline failed because while new tags were created, you forgot to bump the poetry version. The way CI is currently set up in your repo, you will have to do that by hand still (poetry version major|minor|patch)

You can view, comment on, or merge this pull request online at:

https://github.com/rwijtvliet/portfolyo/pull/69 Commit Summary

File Changes

(2 files https://github.com/rwijtvliet/portfolyo/pull/69/files)

Patch Links:

— Reply to this email directly, view it on GitHub https://github.com/rwijtvliet/portfolyo/pull/69, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA7KOHMLNQZTBD53BWEQ5J3YIB4PZAVCNFSM6AAAAABAJOIW5WVHI2DSMVQWIX3LMV43ASLTON2WKOZSGAZDQNRVGI3DSMI . You are receiving this because you are subscribed to this thread.Message ID: @.***>

stefankeidel commented 9 months ago

Package versioning is always a somewhat manual process, as it should be -- you as a maintainer are the one to decide how "major" the changes are. See also here: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

In theory, changes only get merged to main if and when you release, ideally from a release branch where you get to decide on the version. Whether or not that's done via PR is up to you -- you're the maintainer!

rwijtvliet commented 9 months ago

I've tried to describe the process here - does it make sense like this? I know I'm the developer, but I do not have enough experience and just want to follow best practices.

Some additional questions:

Thanks again!

stefankeidel commented 9 months ago

Heyhey!

For feature branch to develop, squashing absolutely makes sense generally. For everything else, rewriting history (which is what squashing is) is frowned upon. I would generally advise rebasing code on top so you have a clean, linear history. That will get rid of the diverging branch histories as well, and they will be in sync.

As far as merging/rebasing release branches to both dev and main, I'm not super sure how to do that in practice either. I would probably rather do relese > main > develop, but likely without pull requests. But it remains to be seen what feels good for your workflow I guess.

We usually forego the release branches and bump the package versions as part of feature commits to develop immediately. But if you tend to accumulate changes for a while before releasing that might obviously not be practical. Depends on your process :)