Skip to content

Commit 4c9d392

Browse files
committed
chore(release-it): 🧹 update release notes template
1 parent 7a17cc4 commit 4c9d392

File tree

5 files changed

+347
-271
lines changed

5 files changed

+347
-271
lines changed

.release-it.cjs

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const {
44
commitPartial,
55
transform,
66
commitGroupsSort,
7-
} = require("./release-it/conventionalChangelogWriterOptsTransform.cjs");
7+
} = require("./release-it/writerOptions.cjs");
88

99
module.exports = {
1010
hooks: {
@@ -15,6 +15,7 @@ module.exports = {
1515
git: {
1616
requireBranch: "main",
1717
requireCommits: true,
18+
requireCleanWorkingDir: false,
1819
commitMessage: "🚀 Release v${version}",
1920
commitArgs: ["--no-verify", "-S"],
2021
tagArgs: ["-s"],

release-it/conventionalChangelogWriterOptsTransform.cjs

-264
This file was deleted.

release-it/getCommitsSinceLastRelease.js

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
import fs from "node:fs";
2-
import { createRequire } from "node:module";
1+
import { readFileSync, writeFileSync } from "node:fs";
32
import { Octokit } from "@octokit/core";
43
import dedent from "dedent";
4+
import { config } from "dotenv";
55
import { execa } from "execa";
66
import gitRemoteOriginUrl from "git-remote-origin-url";
77
import gitUrlParse from "git-url-parse";
88

9-
const require = createRequire(import.meta.url);
10-
const packagejson = require("../package.json");
9+
const packagejson = JSON.parse(readFileSync("./package.json"));
10+
11+
// see https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import
12+
config();
1113

1214
const getOldestCommitSinceLastTag = async () => {
1315
const gitCommandArgs = [
@@ -92,8 +94,7 @@ const getQueryString = (afterCursorString) =>
9294
commitDate,
9395
);
9496

95-
// eslint-disable-next-line node/no-sync
96-
fs.writeFileSync(
97+
writeFileSync(
9798
"release-it/remote-commits.json",
9899
JSON.stringify(remoteCommits),
99100
);

release-it/templates/template.hbs

+23
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,26 @@ Introduced in: [`{{shortHash}}`]({{hashUrl}})
6262
{{/each}}
6363

6464
{{/each}}
65+
66+
{{~#if hasOtherNotableChanges}}
67+
68+
### {{otherNotableChangesTitle}}
69+
70+
71+
{{#each otherNotableChanges}}
72+
73+
{{#if scope}}#### `{{scope}}` {{/if}}
74+
75+
{{#if body}}
76+
{{body}}
77+
{{~/if}}
78+
79+
{{#raw}}{{/raw}}
80+
81+
Introduced in: [`{{shortHash}}`]({{hashUrl}})
82+
83+
{{#raw}}{{/raw}}
84+
85+
{{/each}}
86+
87+
{{/if}}

0 commit comments

Comments
 (0)