Skip to content

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

Merged
merged 5 commits into from
Jun 25, 2024
Merged

Conversation

Nemikolh
Copy link
Member

This PR fixes an issue where packages CHANGELOG.md files included changes unrelated to them.

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Jun 19, 2024

⚠️ No Changeset found

Latest commit: cf5da5f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Nemikolh Nemikolh requested review from d3lm and SamVerschueren June 19, 2024 19:54
@@ -104,7 +104,7 @@ function generateChangelog(pkg) {
};

const gitRawCommitsOpts = {
path: pkg.gitPath ?? path.dirname(pkg.path),
path: pkg.gitPath ?? pkg.path,
Copy link
Member Author

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 😅

@d3lm d3lm changed the title fix: issue with changelog generation chore: fix issue with changelog generation Jun 20, 2024
Copy link
Contributor

@d3lm d3lm left a 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 🙉

@Nemikolh
Copy link
Member Author

Nemikolh commented Jun 20, 2024

Ah sorry I forgot about that one! I'll look into using our own preset 👍

(Btw, Monk is such a good series 🤩)

Copy link

cloudflare-workers-and-pages bot commented Jun 20, 2024

Deploying tutorialkit-demo-page with  Cloudflare Pages  Cloudflare Pages

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

View logs

Copy link

cloudflare-workers-and-pages bot commented Jun 20, 2024

Deploying tutorialkit-docs-page with  Cloudflare Pages  Cloudflare Pages

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

View logs

@d3lm
Copy link
Contributor

d3lm commented Jun 24, 2024

Any updates on this one?

(Btw, Monk is such a good series 🤩)

Yes! Too good.

@Nemikolh
Copy link
Member Author

@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.

@d3lm
Copy link
Contributor

d3lm commented Jun 24, 2024

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.

@Nemikolh
Copy link
Member Author

Yeah, I agree. Let's see what Sam says 👍

@SamVerschueren
Copy link
Contributor

Yeah I totally agree. Let's postpone this.

@Nemikolh Nemikolh requested a review from AriPerkkio June 25, 2024 09:35
@Nemikolh Nemikolh merged commit 42134c9 into main Jun 25, 2024
8 checks passed
@Nemikolh Nemikolh deleted the joan/fix-changelogs branch June 25, 2024 14:38
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