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

Use a custom changelog line generator function to avoid adding meaningless changelog entries #1409

Conversation

NullVoxPopuli
Copy link
Collaborator

@NullVoxPopuli NullVoxPopuli commented May 2, 2023

In the Release Preview PR: #1408

We have a bunch of commits that are duplicated:
image

This is because changesets is using the commit that the changeset file was added, rather than the commit of the actual change.

There are two problems:

  • repeated "dependency updated" entries
  • every change has the same commit.

This PR addresses both of those things.

Preview:
image

This uses a tweaked version of the changelog-git plugin: https://github.com/changesets/changesets/blob/main/packages/changelog-git/src/index.ts

@@ -59,20 +59,19 @@
"**/graceful-fs": "^4.0.0"
},
"devDependencies": {
"@changesets/changelog-github": "^0.4.7",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

unused

"@changesets/cli": "^2.25.0",
"@types/jest": "^29.2.0",
"@typescript-eslint/eslint-plugin": "^4.1.1",
"@typescript-eslint/parser": "^4.1.1",
"changeset-recover": "0.1.0-beta.10",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

using the yarn CLI sorted this file

@NullVoxPopuli NullVoxPopuli requested a review from ef4 May 2, 2023 20:37
Copy link
Member

@mansona mansona left a comment

Choose a reason for hiding this comment

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

I've reviewed this the best I can. Unfortunately I think it's very much in a "let's try it and see" category because it's a bit hard to predict what this will do without having a lot of context into changesets.

Fortunately it's a non-destructive process so there is little lost from just merging it and seeing what happens on the next update 😂

@NullVoxPopuli NullVoxPopuli merged commit f004d11 into embroider-build:main May 8, 2023
199 checks passed
@NullVoxPopuli NullVoxPopuli deleted the ignore-the-dependency-release-line-logic branch May 8, 2023 11:07
@ef4 ef4 added the internal label May 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants