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

WIP: Changelog in repo + autorelease #6593

Draft
wants to merge 22 commits into
base: master
Choose a base branch
from

Conversation

matmair
Copy link
Member

@matmair matmair commented Feb 27, 2024

Placeholder PR; will sketch further out soon

See #4959, #4623

@matmair matmair added CI CI / unit testing ecosystem documentation labels Feb 27, 2024
@matmair matmair added this to the 0.15.0 milestone Feb 27, 2024
@matmair matmair changed the title Changelog in repo + autorelease WIP: Changelog in repo + autorelease Feb 27, 2024
Copy link

netlify bot commented Feb 27, 2024

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

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

@LavissaWoW
Copy link
Contributor

LavissaWoW commented Mar 7, 2024

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!

@SchrodingersGat SchrodingersGat modified the milestones: 0.15.0, 0.16.0 May 14, 2024
@SchrodingersGat
Copy link
Member

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

@matmair
Copy link
Member Author

matmair commented Jun 26, 2024

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

@SchrodingersGat
Copy link
Member

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

@matmair
Copy link
Member Author

matmair commented Jun 30, 2024

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

@SchrodingersGat
Copy link
Member

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

@SchrodingersGat
Copy link
Member

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

@matmair
Copy link
Member Author

matmair commented Aug 19, 2024

Let's move this to 0.17.x

@matmair matmair modified the milestones: 0.16.0, 0.17.0 Aug 19, 2024
@matmair
Copy link
Member Author

matmair commented Aug 19, 2024

.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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI CI / unit testing ecosystem documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants