Skip to content

chore: fix changelog format #791

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

Merged
merged 6 commits into from
Jul 6, 2022
Merged

chore: fix changelog format #791

merged 6 commits into from
Jul 6, 2022

Conversation

shortcuts
Copy link
Member

@shortcuts shortcuts commented Jul 5, 2022

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-570

Changes included:

Content in the changelogs was not usable, we now provide links to the hash commits, and their author.

Updates in this PR:

  • Move git logic introduced in scripts/release/updateAPIVersions.ts to where it belongs in scripts/release/createReleasePR.ts
  • Update changelogs to contain contain links to commits
    • Authors have not been added but will from now on
  • Update tests to be more relevant
    • We now leverage internal functions instead of hardcoded values

🧪 Test

@shortcuts shortcuts requested a review from a team July 5, 2022 15:10
@shortcuts shortcuts self-assigned this Jul 5, 2022
@shortcuts shortcuts requested review from damcou and millotp and removed request for a team July 5, 2022 15:10
@netlify
Copy link

netlify bot commented Jul 5, 2022

Deploy Preview for api-clients-automation canceled.

Name Link
🔨 Latest commit c1636a9
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/62c556ddddee1b0009c97f12

@algolia-bot
Copy link
Collaborator

algolia-bot commented Jul 5, 2022

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

it's hard to try the release process but this looks good, way better changelog !

- 23a72c39 fix(specs): correct type for highlightResult and snippetResult (#783)
- a11e84da fix(specs): fix missing params and types (#772)
- bc14a8c5 feat(specs): Add tags to the settings and search params (#768)
- [23a72c39](https://github.com/algolia/api-clients-automation/commit/23a72c39) fix(specs): correct type for highlightResult and snippetResult (#783)
Copy link
Collaborator

Choose a reason for hiding this comment

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

blasphemy to update the existing changelog 😱 !
it's like trying to cover a murder ahah

Copy link
Member Author

Choose a reason for hiding this comment

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

:DD I don't see what you mean

@shortcuts shortcuts force-pushed the chore/fix-changelog-format branch from 2a23726 to c677f16 Compare July 6, 2022 08:00
@shortcuts shortcuts requested a review from millotp July 6, 2022 08:35
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

Looks good ! final thing about authors

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

the changelog couldn't be better !

@shortcuts shortcuts merged commit bc31210 into main Jul 6, 2022
@shortcuts shortcuts deleted the chore/fix-changelog-format branch July 6, 2022 09:50
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Jul 6, 2022
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Jul 6, 2022
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Jul 6, 2022
medicindev pushed a commit to medicindev/Algolia-Client--JavaScript that referenced this pull request Mar 8, 2025
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.

3 participants