fix: generate correct changelogs when doing a PR #113
Merged
Conversation
This file contains hidden or 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
|
|
AriPerkkio
approved these changes
Jul 4, 2024
There was a problem hiding this comment.
Looks good, tested locally and seems to work nicely.
$ pnpm --recursive --filter "@tutorialkit/*" exec pnpm version --no-git-tag-version --allow-same-version 0.0.1
v0.0.1
v0.0.1
v0.0.1
v0.0.1
v0.0.1
$ pnpm changelog
UPDATED packages/runtime/CHANGELOG.md 0.0.1
UPDATED packages/cli/CHANGELOG.md 0.0.1
UPDATED packages/astro/CHANGELOG.md 0.0.1
UPDATED packages/components/react/CHANGELOG.md 0.0.1
UPDATED packages/theme/CHANGELOG.md 0.0.1
UPDATED packages/types/CHANGELOG.md 0.0.1
UPDATED packages/create-tutorial/CHANGELOG.md 0.0.1-alpha.23
UPDATED CHANGELOG.md 0.0.1
$ git status
modified: CHANGELOG.md
modified: packages/astro/CHANGELOG.md
modified: packages/cli/CHANGELOG.md
modified: packages/components/react/CHANGELOG.md
modified: packages/runtime/CHANGELOG.md
modified: packages/theme/CHANGELOG.md
modified: packages/types/CHANGELOG.md
scripts/changelog/Package.mjs
Outdated
|
|
||
| export class Package { | ||
| /** | ||
| * @param {PackageDefinition} pkg |
There was a problem hiding this comment.
This should be PackageConfiguration?
Suggested change
| * @param {PackageDefinition} pkg | |
| * @param {PackageConfiguration} pkg |
To be able to reference that, let's move it into this file from changelog.mjs instead:
/**
* @typedef {{
* path: string;
* excluded?: true;
* sameAs?: string;
* }} PackageConfiguration A package in the monorepo to generate changelog for.
*/
export class Package {
/**
* @param {PackageConfiguration} pkg
*/Then use it in changelog.mjs:
/**
* @type {import('./changelog/Package.mjs').PackageConfiguration[]}
*/
const PACKAGES = [
{ path: './packages/astro' },
...There was a problem hiding this comment.
Oh this is nice! Thanks 😃
| import fs from 'node:fs'; | ||
| import addStream from 'add-stream'; | ||
| import chalk from 'chalk'; | ||
| import conventionalChangelog from 'conventional-changelog'; |
There was a problem hiding this comment.
FYI the package I mentioned earlier: https://github.com/antfu/changelogithub. It creates changelogs like https://github.com/unocss/unocss/releases/tag/v0.39.0.
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.
This PR fix the changelog generation so that it when we do
pnpm changelogit generate the changelog for every packages, in particular the CLI. The previous release PR didn't had the changelog for the CLI because we are bumping the CLI at a later point.