-
Notifications
You must be signed in to change notification settings - Fork 13
chore: replace changelog tool #711
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -42,6 +42,9 @@ To do consistent releases, we use the following steps: | |
|
|
||
| 1. Create a new issue and branch. | ||
| 1. Update the version number for the mono repo in the `package.json` file. | ||
| 1. Update the version numbers for the packages `jitar`, `create-jitar` and `@jitar/plugin-vite`. | ||
| 1. Update the changelog by running `npm run changelog`. | ||
| 1. Commit and push the changes. | ||
|
Comment on lines
+45
to
+47
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick | 🔵 Trivial Documentation accurately reflects the new workflow. The updated publishing steps correctly document the transition from changeset to manual versioning with auto-changelog. The instructions are clear and actionable. Minor style note: Consider varying the sentence structure to avoid three consecutive sentences starting with "Update" (e.g., "1. Update... 2. Generate the changelog by running... 3. Commit..."). 🧰 Tools🪛 LanguageTool[style] ~46-~46: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) 🤖 Prompt for AI Agents |
||
| 1. Run `npm run publish-packages` to build and publish all packages. | ||
| 1. Create a pull request. | ||
| 1. Once the pull request is merged, tag the release. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| {{#each releases}} | ||
| # {{title}} | ||
| [{{isoDate}}] | ||
|
|
||
| {{#commit-list | ||
| merges | ||
| heading='### BREAKING CHANGES' | ||
| message='^\w+(?:(\(\w+\))|)!:'}} | ||
| * \[[{{id}}]({{href}})] {{commit.subject}} by {{commit.author}} | ||
| {{/commit-list}} | ||
|
|
||
| {{#commit-list | ||
| merges | ||
| heading='### Features' | ||
| message='feat(?:(\(\w+\))|):'}} | ||
| * \[[{{id}}]({{href}})] {{commit.subject}} by {{commit.author}} | ||
| {{/commit-list}} | ||
|
|
||
| {{#commit-list | ||
| merges | ||
| heading='### Fixes' | ||
| message='(bug(?:(\(\w+\))|):)|(fix(?:(\(\w+\))|):)'}} | ||
| * \[[{{id}}]({{href}})] {{commit.subject}} by {{commit.author}} | ||
| {{/commit-list}} | ||
|
|
||
| {{#commit-list | ||
| merges | ||
| heading='### Chores' | ||
| message='(chore(?:(\(\w+\))|):)|(build(?:(\(\w+\))|):)|(npm(?:(\(\w+\))|):)'}} | ||
| * \[[{{id}}]({{href}})] {{commit.subject}} by {{commit.author}} | ||
| {{/commit-list}} | ||
|
|
||
| {{#commit-list | ||
| merges | ||
| heading='### Other' | ||
| exclude='(feat(?:(\(\w+\))|):)|(chore(?:(\(\w+\))|):)|(build(?:(\(\w+\))|):)|(npm(?:(\(\w+\))|):)|(fix(?:(\(\w+\))|):)|(bug(?:(\(\w+\))|):)|(^\w+(?:(\(\w+\))|)!:)'}} | ||
| * \[[{{id}}]({{href}})] {{commit.subject}} by {{commit.author}} | ||
| {{/commit-list}} | ||
|
|
||
| {{/each}} |
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.
Typo in commit message.
The commit message contains "dependenciy" instead of "dependency". This typo originates from the original commit and is now reflected in the generated changelog.
Note: This cannot be corrected in the changelog without amending the historical commit message.
🧰 Tools
🪛 LanguageTool
[grammar] ~58-~58: Ensure spelling is correct
Context: ...skingTechnology/jitar/pull/652)] chore: dependenciy updates (#652) by dependabot[bot] * [[...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents