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

v0.5.5 release prep #348

Merged
merged 5 commits into from
Jul 27, 2022
Merged

v0.5.5 release prep #348

merged 5 commits into from
Jul 27, 2022

Conversation

alexweininger
Copy link
Member

No description provided.

@alexweininger alexweininger requested a review from a team as a code owner July 27, 2022 20:48
nturinski
nturinski previously approved these changes Jul 27, 2022
CHANGELOG.md Outdated
@@ -2,6 +2,17 @@

## Unreleased
Copy link
Member

Choose a reason for hiding this comment

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

Have we not been removing this between releases? Should we?

Copy link
Member Author

Choose a reason for hiding this comment

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

We could remove it since we don't use it, but I also wish we used it...

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll try out using it for the next release cycle and see how it goes. If we don't like it we'll remove it.

It's nice to keep a log of the changes as we make them so that we don't miss anything important when it comes to releasing. Also makes it easier on the person piloting the release 😄

Copy link
Member

Choose a reason for hiding this comment

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

We could remove it since we don't use it, but I also wish we used it...

How hard would it be to write two scripts:

  • Adds ##Unreleased to CHANGELOG at the same time the package.json is bumped
  • Add the commit message as a bullet point under ##Unreleased after each merge

Copy link
Member Author

@alexweininger alexweininger Jul 27, 2022

Choose a reason for hiding this comment

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

Adds ##Unreleased to CHANGELOG at the same time the package.json is bumped
Add the commit message as a bullet point under ##Unreleased after each merge

Both are possible and can be easily accomplished using existing tools. There's even one built and maintained by Microsoft called beachball

There are also simpler ones, like the one used by the SWA CLI repository which generates the changelog based on prefixes you add to the commit message

@alexweininger alexweininger merged commit 0eca079 into main Jul 27, 2022
@alexweininger alexweininger deleted the alex/prep-v0.5.5 branch July 27, 2022 22:41
@microsoft microsoft locked and limited conversation to collaborators Sep 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants