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): release v2.4.0 #797

Merged
merged 1 commit into from
Oct 10, 2024
Merged

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Oct 9, 2024

2.4.0 (2024-10-10)

🚀 Features

  • Introduce first version of object interface (#756)

🪲 Bug Fixes

  • Sync food (#759)
  • Don't hide version information on staging (#778)
  • Reset physical durablility in regulatory mode (#786)
  • (api,food) Nullable fields weren't nullable anymore. (#789)

🚜 Refactor

  • Small textile explorer improvements (#773)

⚙️ Miscellaneous Tasks

  • Don't download draft releases (#771)
  • Remove airTransportRatio from examples (#785)
  • Cleanup package-lock.json. (#787)
  • Use builtin python action cache for pipenv (#796)
  • Improve changelog by using git-cliff (#768)

vjousse added a commit that referenced this pull request Oct 10, 2024
## 🔧 Problem

We can't customize the changelog generated by
[release-please](https://github.com/googleapis/release-please), so it's
impossible to filter technical and non technical changes.

Moreover only `fix` and `feat` commits are parts of the changelog,
sometimes it would make sense to add `chore`, `refactor` and `doc`
changes to the changelog.

## 🍰 Solution

Use [`git-cliff`](https://git-cliff.org/) to generate the changelog and
create the tags too. The process is the same than with `release-please`,
it will create an automated PR that, when merged, will tag the
appropriate version and create a release.


## 🚨  Points to watch/comments

Commits that are only relative to `data/` are excluded from the
changelog.

We will be able to fully test this PR only once it will be merged into
master and once a release will be created. I did all the tests that I
could without merging, see below.

## 🏝️ How to test

The generated PR will look like this one:
#797
> [!IMPORTANT]
> This automated PR was updated using the commits of this PR, so once
this is merged into `master`, the changelog will only contain the
squashed commits of the `master` branch.

The different workflows were tested extensively here:
https://github.com/vjousse/git-cliff-release-creation-exemple

I did a test on this PR by enabling release creation on commit push here
(instead of merging the changelog PR). The tag and the release
(configured as draft in my test) was created as expected, see the
screenshots below.

![Screenshot 2024-10-09 at 15-53-53 Tags ·
MTES-MCT_ecobalyse](https://github.com/user-attachments/assets/21f27b56-3f04-43bb-9b95-9be239a63664)
![Screenshot 2024-10-09 at 15-53-32 Releases ·
MTES-MCT_ecobalyse](https://github.com/user-attachments/assets/070e5939-53ea-44a1-b853-17ee33d76340)

I have removed the tag and the draft PR since.
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@vjousse vjousse self-requested a review October 10, 2024 09:50
@vjousse vjousse merged commit 74365af into master Oct 10, 2024
2 checks passed
@vjousse vjousse deleted the chore/next-release-changelog branch October 10, 2024 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant