-
Notifications
You must be signed in to change notification settings - Fork 85
chore: fix issue with changelog generation #82
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
Conversation
|
|
@@ -104,7 +104,7 @@ function generateChangelog(pkg) { | |||
}; | |||
|
|||
const gitRawCommitsOpts = { | |||
path: pkg.gitPath ?? path.dirname(pkg.path), | |||
path: pkg.gitPath ?? pkg.path, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was the source of the bug 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool. Would be super sweet if we can improve the formatting in terms of the extra newlines but if it's too much work then maybe it's not worth it. My inner Monk tells me to fix this 🙉
Ah sorry I forgot about that one! I'll look into using our own preset 👍 (Btw, Monk is such a good series 🤩) |
Deploying tutorialkit-demo-page with
|
Latest commit: |
cf5da5f
|
Status: | ✅ Deploy successful! |
Preview URL: | https://9b283548.tutorialkit-demo-page.pages.dev |
Branch Preview URL: | https://joan-fix-changelogs.tutorialkit-demo-page.pages.dev |
Deploying tutorialkit-docs-page with
|
Latest commit: |
4a2fdde
|
Status: | ✅ Deploy successful! |
Preview URL: | https://43394a98.tutorialkit-docs-page.pages.dev |
Branch Preview URL: | https://joan-fix-changelogs.tutorialkit-docs-page.pages.dev |
Any updates on this one?
Yes! Too good. |
@d3lm So we had talked about this PR with @SamVerschueren and decided to wait for you to be back before moving forward with this PR. In particular we were thinking that it could be great to also auto-include the contributors to give them a big shoutout as part of the changelog. @SamVerschueren had an idea of using the GitHub API in order to get all the commits that should be included in the changelog and also get the Contributors usernames. If we went that route though it essentially mean writing our own tool which I think is fine but meant that we should probably discuss it first. |
Yea I like auto-adding the contributors to the changelog! Only thing I am wondering about is value and effort. I think we have plenty of other high prio things to work. I generally like the idea that @SamVerschueren had but since we don't have a ton of contributors yet the investment may not be worth it right now, wdyt? What I am thinking is that we can start automating this once we have more external people contributing to the project. |
Yeah, I agree. Let's see what Sam says 👍 |
Yeah I totally agree. Let's postpone this. |
This PR fixes an issue where packages
CHANGELOG.md
files included changes unrelated to them.