Unable to generate the latest version's changelog

[cookpete]

Unable to generate the latest version's changelog

[cookpete]

Hey @ahmadawais,

You are using "package": true which is only intended to be used when you generate a changelog during npm version, which you are not using. This setting gets the version from your package.json and uses that as the next incoming version, but in your case it is just the current version of your library, which is messing stuff up.

This is why you have a compare link at the top of your log that is comparing a version to itself:

### [1.34.0](https://github.com/ahmadawais/shades-of-purple-vscode/compare/1.34.0...1.34.0) RELEASE

[cookpete]

Ah I see now that release-it will bump the version in package.json and do a bunch of stuff before auto-changelog runs. Try running it without "package": true in the config and see if that helps.

[ahmadawais]

@cookpete thanks for the response.

Yes, using release-it and it should handle the package.json update and as soon as it does, I want the auto-changelog to report the release. Without package: true it listed the changes under unreleased.

[cookpete]

In the next example, beforeChangelogCommand is also used, to update the CHANGELOG.md file. This change will also be included in the release commit.

{
 "increment": "conventional:angular",
 "beforeChangelogCommand": "conventional-changelog -p angular -i CHANGELOG.md -s",
 "changelogCommand": "conventional-changelog -p angular | tail -n +3",
 "safeBump": false
}

For this use case, the safeBump option was introduced. Set this to false to bump package.json#version before the beforeChangelogCommand is executed, as the conventional-changelog tool needs to run from the current version.

From https://www.npmjs.com/package/release-it#generate-custom-changelog

Try removing the auto-changelog steps from your release script and instead add to your release-it config:

{
 "beforeChangelogCommand": "auto-changelog",
 "safeBump": false
}

[ahmadawais]

@cookpete thanks for helping me out on this one.

I tried what you asked.

I released a new version 1.35.0 https://github.com/ahmadawais/shades-of-purple-vscode/releases

But the changelog is till 1.34.0 :( https://github.com/ahmadawais/shades-of-purple-vscode/blob/master/CHANGELOG.md

Here's the output

> release-it && npx vsce publish

✔ Bump version
⠦ Command (auto-changelog)23650 bytes written to CHANGELOG.md
✔ Command (auto-changelog)
✔ Init (release 1.35.0 for shades-of-purple)
✔ Git commit
✔ Git tag
✔ Git push
✔ GitHub release
✔ GitHub upload assets
✔ npm publish
✔ Done (in 46s.)
npx: installed 63 in 11.213s
Publishing [email protected]...
Successfully published [email protected]!

As you can see the bump of version was before auto-changelog was run.

I have also removed package = true as you suggested.

[cookpete]

Haha sorry @ahmadawais.. Now you're doing it this way you actually need package: true after all to use the bumped version.

[ahmadawais]

Hahah!

I think I finally figured it out. The unreleased thingy has conflict with package option. They don't play well together. I had to remove it.

Now I have this

"auto-changelog": {
		"output": "CHANGELOG.md",
		"template": "clTemplate.hbs",
		"commitLimit": false,
		"package": true,
		"replaceText": {
			"FIX: ": "",
			"NEW: ": "",
			"IMPROVE: ": "",
			"DOC: ": ""
		}
	}

And it works! Voila!

Look at these sexy changelogs

https://github.com/ahmadawais/shades-of-purple-vscode/blob/master/CHANGELOG.md

and

https://marketplace.visualstudio.com/items/ahmadawais.shades-of-purple/changelog

Thanks for all the help man. You're very kind.