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

chore: release v14.1.0 #1974

Merged

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Oct 12, 2023

🤖 I have created a release beep boop

14.1.0


This PR was generated with Release Please. See documentation.

@bpmn-io-tasks bpmn-io-tasks bot added the needs review Review pending label Oct 12, 2023
@barmac
Copy link
Member

barmac commented Oct 12, 2023

The duplicated commit is due to my commit amendment on master + merge-to-develop action 🤡

@github-actions github-actions bot force-pushed the release-please--branches--master--components--bpmn-js branch from 1c11c45 to 483c056 Compare October 12, 2023 12:55
@barmac
Copy link
Member

barmac commented Oct 12, 2023

OK duplicated commit message is fixed now.

@barmac
Copy link
Member

barmac commented Oct 12, 2023

Regarding this PR, I can see a couple of potential improvements:

  • PR title should not contain the branch name master
  • PR should be auto-assigned to modeling-dev
  • We will need to be careful with commit messages to safe us some work. Notice how Closes https://github.com/bpmn-io/bpmn-js/issues/557 was placed in the deps commit of https://github.com/bpmn-io/bpmn-js/pull/1972/commits, and therefore ignored by the tool.

@barmac barmac requested a review from nikku October 12, 2023 13:02
@barmac barmac changed the title chore(master): release 14.0.1 chore: release 14.0.1 Oct 12, 2023
@nikku
Copy link
Member

nikku commented Oct 12, 2023

@barmac I do not understand this:

[...] was placed in the deps commit of https://github.com/bpmn-io/bpmn-js/pull/1972/commits, and therefore ignored by the tool.

For us we regularily upgrade our dependencies, fixing issues. How is this being ignored?

CHANGELOG.md Outdated
## [14.0.1](https://github.com/bpmn-io/bpmn-js/compare/v14.0.0...v14.0.1) (2023-10-12)


### Bug Fixes
Copy link
Member

Choose a reason for hiding this comment

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

Do we plan to adjust our changelogs? I'd advocate not to do it (just yet).

Copy link
Member

Choose a reason for hiding this comment

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

We can:

  1. (try to) Create a custom changelog template for release-please which resembles our current practice.
  2. Accept the default release-please template for this and future updates.
  3. Manually adjust the automatic changelog updates so that we stick to our current practice (until (1) is implemented).

I am OK with (2) as long as the default release-please template is good enough. I don't think our current changelog template is better than that.

Copy link
Member

Choose a reason for hiding this comment

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

Let me know what you think.

Copy link
Member

Choose a reason for hiding this comment

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

I like our existing template, because it is compact, and meaningful.

What you propose hides a major feature (cf. #557).

Copy link
Member

Choose a reason for hiding this comment

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

Also this clearly shows a gap in release-please. A new feature (local spacetool) may never be a patch.

Copy link
Member

Choose a reason for hiding this comment

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

A new feature (local spacetool) may never be a patch.

I totally agree with you. That's why we need to be extra careful with commit messages if we want automation. So it's no more "oh you labeled is as patch-releasable, but it's a feature in fact". Or we review automation result manually.

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps it would make more sense to do sth like:

deps: update diagram-js to v12.2.0

feat: support local space tool

Closes #758

https://github.com/googleapis/release-please#what-if-my-pr-contains-multiple-fixes-or-features

Copy link
Member

Choose a reason for hiding this comment

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

Let's discuss this. If we want automation, then we want to be super strict about our commits. If we think we can be, then let's try it :).

Copy link
Member

Choose a reason for hiding this comment

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

Hmm custom changelog seems to be doable, but I couldn't find a way to do it in the github action:

https://github.com/googleapis/release-please/blob/main/docs/customizing.md#adding-additional-changelog-types

I did not dive deep though.

@barmac
Copy link
Member

barmac commented Oct 12, 2023

For us we regularily upgrade our dependencies, fixing issues. How is this being ignored?

I will check if we can easily include deps commits in the automatic changelog update.

@barmac
Copy link
Member

barmac commented Oct 12, 2023

For us we regularily upgrade our dependencies, fixing issues. How is this being ignored?

I will check if we can easily include deps commits in the automatic changelog update.

This is doable via https://github.com/google-github-actions/release-please-action#overriding-the-changelog-sections

@barmac
Copy link
Member

barmac commented Oct 12, 2023

I've created some adjustments and will push them to test.

@github-actions github-actions bot changed the title chore: release 14.0.1 chore: release v14.0.1 Oct 12, 2023
@github-actions github-actions bot force-pushed the release-please--branches--master--components--bpmn-js branch from efe9885 to 2f5733e Compare October 12, 2023 14:03
@barmac
Copy link
Member

barmac commented Oct 12, 2023

OK it's applied in the PR. WDYT?

@barmac
Copy link
Member

barmac commented Oct 13, 2023

According to https://github.com/google-github-actions/release-please-action/issues/838, we cannot fully customize the changelog at the moment, if we stick to the release-please-action. I'd rather not switch to the CLI tool though. @nikku

@barmac
Copy link
Member

barmac commented Oct 13, 2023

We can also try out github way of doing release notes.

@github-actions github-actions bot force-pushed the release-please--branches--master--components--bpmn-js branch from 2f5733e to dd6e148 Compare October 13, 2023 11:29
@barmac barmac requested a review from nikku October 13, 2023 11:29
@barmac
Copy link
Member

barmac commented Oct 13, 2023

It looks like a step back to me ;) WDYT @nikku ?

@nikku
Copy link
Member

nikku commented Oct 13, 2023

Let's discuss with the team. I'm not a fan of overly verbose changelogs, and I also think a little bit of updating (cross-checking what we released) does not hurt.

The original ones the tool generated can trivially be grouped to fit our own CHANGELOG style, and we can learn how to write better commit messages (combine deps and feat).

But if I'm the only one in favor of keeping our changelogs, then I'm happy to adjust, too.

@nikku
Copy link
Member

nikku commented Oct 13, 2023

In terms of compactness I obviously prefer the github style. However it seems to swallow dependency bumps.

@barmac barmac force-pushed the release-please--branches--master--components--bpmn-js branch from 37e37a3 to a38eb82 Compare October 17, 2023 11:43
@barmac barmac changed the title chore: release v14.0.1 chore: release v14.1.0 Oct 17, 2023
@barmac barmac force-pushed the release-please--branches--master--components--bpmn-js branch from a38eb82 to 799f746 Compare October 17, 2023 11:46
@barmac barmac merged commit 0f79949 into master Oct 17, 2023
6 of 9 checks passed
@barmac barmac deleted the release-please--branches--master--components--bpmn-js branch October 17, 2023 11:47
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Oct 17, 2023
@github-actions
Copy link
Contributor Author

🤖 Release is at https://github.com/bpmn-io/bpmn-js/releases/tag/v14.1.0 🌻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants