chore(scripts): improve release script with git diff [skip-bc] #3686
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
No code generatedIf you believe code should've been generated, please, report the issue. 📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
shortcuts
reviewed
Sep 11, 2024
| continue; | ||
| } | ||
|
|
||
| // sometimes the scope of the commits is not set correctly and concerns another language, we can fix it. | ||
| if (LANGUAGES.includes(validCommit.scope as Language) && validCommit.scope !== lang) { | ||
| validCommit.message = validCommit.message.replace(`(${validCommit.scope}):`, `(${lang}):`); |
There was a problem hiding this comment.
is this reflected in the changelog? I'd rather keep it matching the git history but still include it in the new version computing if possible
There was a problem hiding this comment.
I find it weird to see a feat(python): add linter in the java changelog
There was a problem hiding this comment.
can we replace it with feat(clients) maybe then?
There was a problem hiding this comment.
just make the scope wider idk D: it's weird to differ from the git history imo but you are right
millotp
changed the title
shortcuts
approved these changes
Sep 11, 2024
algolia-bot
added a commit
to algolia/algoliasearch-client-csharp
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-dart
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-go
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-java
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-javascript
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-kotlin
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-php
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-python
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-ruby
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-scala
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-swift
that referenced
this pull request
Sep 11, 2024
…ated) algolia/api-clients-automation#3686 Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧭 What and Why
For the longest time, we based changelogs and release on the commit title only, but its often misleading or wrong.
Instead, we can use
git diffto know exactly which commits impact which client, and based the release and changelog based of that.Also take the time to refactor and simplify the release script and lint the tests.
The changelog will automatically use the correct language scope also, even if the commit was wrong.