Skip to content
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

[BUG] No changelog data for 3.2.2 #790

Closed
christian-hawk opened this issue Oct 12, 2022 · 5 comments
Closed

[BUG] No changelog data for 3.2.2 #790

christian-hawk opened this issue Oct 12, 2022 · 5 comments
Labels

Comments

@christian-hawk
Copy link

Version 3.2.2 was released but there is no information about it in changelog

## v3.2.1 (2022-01-21)

@srd90
Copy link

srd90 commented Oct 12, 2022

While waiting changelog update here is reference to 3.2.2's content: https://github.com/node-saml/passport-saml/releases/tag/v3.2.2

See security advisory GHSA-m974-647v-whv7

@christian-hawk
Copy link
Author

christian-hawk commented Oct 13, 2022

Now that 3.2.3 is released, there is changelog content for 3.2.2 but 3.2.3 is missing:

https://github.com/node-saml/passport-saml/blob/v3.2.3/CHANGELOG.md#v322-2022-10-11

Changes are shown in the upper 3.x section, even that 3.2.3 is released and published.

As the process of releasing is done manually by release-it by @cjbarth , I cannot find any problem for now. The changelog is created with the current branch name instead of the new tag. Maybe is related to the post hook npm run changelog in .release-it.json file.

@cjbarth
Copy link
Collaborator

cjbarth commented Oct 14, 2022

The changelog is built automatically from PRs and their labels by pulling data from GitHub. At the time I go to make another release, there is no tag for the latest release on GitHub yet (or anywhere). So, the tool can only specify the commits remaining on the branch after the last tag. I'm trying to get in the habit of modifying the generated changelog to specify the version I'm about to release, but, if I forget, the release contains what is at the top of the changelog. Does that make sense?

@cjbarth cjbarth closed this as completed Oct 14, 2022
@christian-hawk
Copy link
Author

@cjbarth the way I see the release X.Y.z should be in X.Y.z section. Please also keep in mind that ci tools such as dependabot and others, links to a non-existant changelog section.

@cjbarth
Copy link
Collaborator

cjbarth commented Oct 21, 2022

the release X.Y.z should be in X.Y.z section

I'm not sure I follow. Isn't that the way most of the CHANGELOG is?

ci tools such as dependabot and others, links to a non-existant changelog section

Do you happen to have a reference for how such tools parse a CHANGELOG file so we can make sure ours matches the parsable format?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants