fix(changelog): improvements to generation

Author: sladg

Diff for: lib/cli.ts

@@ -72,7 +72,18 @@ program
 	.action(async (options) => {
 		console.log('Our config is: ', options)
 		const { tagPrefix, failOnMissingCommit, releaseBranchPrefix, forceBump, gitUser, gitEmail, changelog } = options
-		wrapProcess(shipitHandler({ tagPrefix, gitEmail, gitUser, failOnMissingCommit, forceBump, releaseBranchPrefix, generateChangelog: changelog }))
+		wrapProcess(
+			shipitHandler({
+				tagPrefix,
+				gitEmail,
+				gitUser,
+				failOnMissingCommit,
+				forceBump,
+				releaseBranchPrefix,
+				generateChangelog: changelog,
+				changelogPath: path.resolve(commandCwd, './CHANGELOG.md'),
+			}),
+		)
 	})
 
 program
@@ -95,7 +106,7 @@ program
 	.command('changelog')
 	.description('Generate changelog from Git, assuming tag being a release.')
 	.option('--outputFile <path>', 'Path to file where changelog should be written.', path.resolve(commandCwd, './CHANGELOG.md'))
-	.option('--gitBaseUrl <url>', 'Absolute URL to ', undefined)
+	.option('--gitBaseUrl <url>', 'Absolute URL to your git project', undefined)
 	.action(async (options) => {
 		console.log('Our config is: ', options)
 		const { outputFile, gitBaseUrl } = options

Diff for: lib/cli/changelog.ts

@@ -28,14 +28,9 @@ export const changelogHandler = async ({ outputFile, gitBaseUrl }: Props) => {
 		throw new Error('Could not determine git base URL!')
 	}
 
-	const log = await git.log({ '--max-count': 20 })
 	await git.fetch(['--tags'])
 
 	const tags = await git.tags()
-
-	console.log('Last commits: ', log)
-	console.log('Last tags: ', tags)
-
 	const sortedTags = sortTagsDescending(tags.all)
 
 	// Sorted from newest to oldest (highest version to lowest).
@@ -66,7 +61,6 @@ export const changelogHandler = async ({ outputFile, gitBaseUrl }: Props) => {
 	const changelog: string[] = []
 
 	changelog.push('# Changelog')
-	changelog.push(`Current version: ${packageJson.version}`)
 
 	result.forEach((a) => {
 		changelog.push('\n')
@@ -75,7 +69,6 @@ export const changelogHandler = async ({ outputFile, gitBaseUrl }: Props) => {
 		const logs = a.log as DefaultLogFields[]
 
 		logs.forEach((b) => {
-			console.log(b.refs)
 			changelog.push(`* ${b.message} \[[${b.hash}](${getCommitLink(gitUrl, b.hash)})\]`)
 		})
 	})

Diff for: lib/cli/shipit.ts

@@ -11,9 +11,19 @@ interface Props {
 	releaseBranchPrefix: string
 	forceBump: boolean
 	generateChangelog: boolean
+	changelogPath: string
 }
 
-export const shipitHandler = async ({ gitEmail, gitUser, tagPrefix, failOnMissingCommit, forceBump, releaseBranchPrefix, generateChangelog }: Props) => {
+export const shipitHandler = async ({
+	gitEmail,
+	gitUser,
+	tagPrefix,
+	failOnMissingCommit,
+	forceBump,
+	releaseBranchPrefix,
+	generateChangelog,
+	changelogPath,
+}: Props) => {
 	const git = simpleGit()
 
 	// Fetch tags to ensure we have the latest ones.
@@ -94,7 +104,7 @@ export const shipitHandler = async ({ gitEmail, gitUser, tagPrefix, failOnMissin
 	if (generateChangelog) {
 		console.log('Generating changelog...')
 
-		await changelogHandler({ outputFile: './CHANGELOG.md' })
+		await changelogHandler({ outputFile: changelogPath })
 		await git.add('./*').raw('commit', '--amend', '--no-edit')
 	}