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

Adapt poetry release workflow for new changelog action #214

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

DerTiedemann
Copy link
Contributor

No description provided.

@DerTiedemann DerTiedemann merged commit 47eb70d into main Nov 7, 2024
3 checks passed
@DerTiedemann DerTiedemann deleted the tiedemann/python-poetry-changelog-action branch November 7, 2024 09:07
DerTiedemann added a commit to bakdata/template-python-poetry that referenced this pull request Nov 7, 2024
DerTiedemann added a commit that referenced this pull request Nov 13, 2024
New changelog generator: https://git-cliff.org/
This action updated replaces the previous generator with the
aforementioned tool.

All existing functionality has been preserved and some new things have
been added, most notably the first contribution mention. The action will
check of there is a `cliff.toml` present in the current repo and if not
use the default that is present inside of this repo. Custom configs are
sometimes required to filter out commits that dont contain meaningful
changes like version bumps. An example of how this could look for
streams-bootstrap:
```toml
commit_parsers = [
  { message = "^\\[Gradle Release Plugin\\]", skip = true },
  { message = "^Changelog for version .*", skip = true },
]
```

Which turns changelogs that look like this:
2024-06-12

* [Gradle Release Plugin] - new version commit: '2.22.2-SNAPSHOT'. by
@bakdata-bot

* Changelog for version 2.22.1 by @bakdata-bot

* Add dynamic application.server config to streams app chart by
@philipp94831 in
[#214](bakdata/streams-bootstrap#214)

* [Gradle Release Plugin] - pre tag commit:  '2.23.0'. by @bakdata-bot

**Full Changelog**:
bakdata/streams-bootstrap@2.22.1...2.23.0

into this:
2024-06-12

* Add dynamic application.server config to streams app chart by
@philipp94831 in
[#214](bakdata/streams-bootstrap#214)

**Full Changelog**:
bakdata/streams-bootstrap@2.22.1...2.23.0

<hr>

For more config options have a look at the docs, this thing is pretty
powerful. Let me know what you think.
DerTiedemann added a commit that referenced this pull request Nov 13, 2024
New changelog generator: https://git-cliff.org/
This action updated replaces the previous generator with the
aforementioned tool.

All existing functionality has been preserved and some new things have
been added, most notably the first contribution mention. The action will
check of there is a `cliff.toml` present in the current repo and if not
use the default that is present inside of this repo. Custom configs are
sometimes required to filter out commits that dont contain meaningful
changes like version bumps. An example of how this could look for
streams-bootstrap:
```toml
# ommited
commit_parsers = [
  { message = "^\\[Gradle Release Plugin\\]", skip = true },
  { message = "^Changelog for version .*", skip = true },
]
```

Which turns changelogs that look like this:
## [2.23.0](https://github.com/bakdata/streams-bootstrap/tree/2.23.0) -
2024-06-12
### What's changed

* [Gradle Release Plugin] - new version commit: '2.22.2-SNAPSHOT'. by
@bakdata-bot

* Changelog for version 2.22.1 by @bakdata-bot

* Add dynamic application.server config to streams app chart by
@philipp94831 in
[#214](bakdata/streams-bootstrap#214)

* [Gradle Release Plugin] - pre tag commit:  '2.23.0'. by @bakdata-bot


**Full Changelog**:
bakdata/streams-bootstrap@2.22.1...2.23.0

into this:
## [2.23.0](https://github.com/bakdata/streams-bootstrap/tree/2.23.0) -
2024-06-12
### What's changed

* Add dynamic application.server config to streams app chart by
@philipp94831 in
[#214](bakdata/streams-bootstrap#214)


**Full Changelog**:
bakdata/streams-bootstrap@2.22.1...2.23.0


<hr>

For more config options have a look at the docs, this thing is pretty
powerful. Let me know what you think.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants