InvenTree icon indicating copy to clipboard operation
InvenTree copied to clipboard

WIP: Changelog in repo + autorelease

Open matmair opened this issue 1 year ago • 10 comments

Placeholder PR; will sketch further out soon

See https://github.com/inventree/InvenTree/issues/4959, https://github.com/inventree/InvenTree/issues/4623

matmair avatar Feb 27 '24 23:02 matmair

Deploy Preview for inventree-web-pui-preview canceled.

Name Link
Latest commit ad4840cf736eea6adafa17a45e5e6dc10d00610e
Latest deploy log https://app.netlify.com/sites/inventree-web-pui-preview/deploys/66b625fca1dd6900080cd5ff

netlify[bot] avatar Feb 27 '24 23:02 netlify[bot]

I like it! I'm a big fan of user-friendly update notes. You don't need to tell everyone that you changed the return of fn(x) from int to str. Let the users know what they're going to notice. At work, we use the term "politically correct" writing, and I think this fits that bill perfectly!

LavissaWoW avatar Mar 07 '24 01:03 LavissaWoW

@matmair sorry did not get to look at this yet, but let's make it a focus for 0.16.0

SchrodingersGat avatar May 14 '24 09:05 SchrodingersGat

@SchrodingersGat what is your general position on keeping a dedicated CHANGELOG file? Should this target 0.16.0?

matmair avatar Jun 26 '24 21:06 matmair

@matmair my main concern is the extra effort it would take to maintain. Could we limit it to major features / fixes / breaking changes?

SchrodingersGat avatar Jun 29 '24 10:06 SchrodingersGat

I think everything that is breaking and any major new feature (everything we would put into the release notes/blog) should be included

matmair avatar Jun 30 '24 12:06 matmair

@matmair this is the last outstanding PR for 0.16.x - is it in a state ready for review / merge?

SchrodingersGat avatar Aug 19 '24 10:08 SchrodingersGat

Can you explain the workflow that would cause .github/workflows/do_release.yaml to be run - and what the effects would be?

SchrodingersGat avatar Aug 19 '24 10:08 SchrodingersGat

Let's move this to 0.17.x

matmair avatar Aug 19 '24 17:08 matmair

.github/workflows/do_release.yaml would be run by manually dispatching it. You could select if you wanted to release from master or stable and the action would then gather the auto-generated changelog, add the manual changelog above and create a release. After that the normal release things would start

matmair avatar Aug 19 '24 17:08 matmair