Skip to content

Align auto-changelog with monorepo tooling - #100

Merged
GuillaumeRx merged 7 commits into
mainfrom
gr/auto-changelog-pr10
Oct 22, 2026
Merged

GuillaumeRx merged 7 commits into
mainfrom
gr/auto-changelog-pr10

Conversation

@GuillaumeRx

@GuillaumeRx GuillaumeRx commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Explanation

Align the staged @metamask/auto-changelog package with monorepo conventions:

  • switch to ESM-only output and Execa 8;
  • migrate existing Jest tests to Vitest;
  • align scripts, metadata, Node support, TypeScript, and lint rules.

The package remains outside committed workspaces until final integration.

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

@GuillaumeRx
GuillaumeRx marked this pull request as ready for review October 22, 2026 09:01
@GuillaumeRx
GuillaumeRx requested a review from a team as a code owner October 22, 2026 09:01
@GuillaumeRx
GuillaumeRx deployed to default-branch October 22, 2026 09:01 — with GitHub Actions Active
Comment thread merged-packages/auto-changelog/src/validate-command/validate.test.ts Outdated
Comment thread merged-packages/auto-changelog/src/validate-command/validate.test.ts Outdated
`Utilities for validating and updating "Keep a Changelog" formatted changelogs.\nUsage: $0 [command] [options]`,
);
)
.parse()) as {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why is this needed now?

@GuillaumeRx GuillaumeRx Oct 22, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

In @types/yargs v17 the argv type is Promise | object makes it impossible to destructure without a type error. We'd need to change how we declare command's arguments to do it cleanly.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I created a regular type for it

Comment thread merged-packages/auto-changelog/src/cli.ts Outdated
Comment on lines 6 to 8
// Oxfmt is ESM-only, and Jest doesn't work well with ESM. We'll want to
// switch to Vitest eventually anyway, so for now we'll just skip this test.
it.todo('formats changelog with Oxfmt when installed');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We can do this now

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Can we do that when this is in packages ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes.

Comment thread merged-packages/auto-changelog/src/parse-changelog.ts Outdated
Comment thread merged-packages/auto-changelog/src/repo.test.ts
Comment thread merged-packages/auto-changelog/CHANGELOG.md Outdated
@GuillaumeRx
GuillaumeRx requested a review from Mrtenz October 22, 2026 09:52
@GuillaumeRx
GuillaumeRx added this pull request to the merge queue Oct 22, 2026
Merged via the queue into main with commit 5a45469 Oct 22, 2026
51 checks passed
@GuillaumeRx
GuillaumeRx deleted the gr/auto-changelog-pr10 branch October 22, 2026 10:03
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.

2 participants