Add token and ref input options

[taiki-e]

• Add token input option to use the specified token instead of GITHUB_TOKEN environment variable.
• Add ref input option to use the specified tag ref instead of GITHUB_REF environment variable.

Option names are from actions/checkout.

Closes #14
Partially replaces #15

[taiki-e]

cc @kirrg001: Is this enough to fix #14?

I'm not sure about the changelog format you mention in #15, but if a properly documented format exists, I think it is possible to have the parse-changelog support it. (Although I don't think a simple parsing in bash will work due to the complexity of markdown)

Also, I added you as the co-author of the second commit because you were working on a similar thing in #15.

[kirrg001]

Yeah thanks a lot 👍 token and refs looks great

I'm not sure about the changelog format you mention in #15, but if a properly documented format exists, I think it is possible to have the parse-changelog support it. (Although I don't think a simple parsing in bash will work due to the complexity of markdown)

So yeah. The code I have shown was just a hack to see that it works. The parser did not work for me.

The parser would need to support the Lerna conventional changelog format which uses e.g. titles with anchors based on tags. Or the parser returned too many lines, which was unexpected (e.g. when the title was # 2.7.0 (2022-08-31)

See lerna changelog as an example. Lerna is using conventional changelog specification.

[taiki-e]

See lerna changelog as an example. Lerna is using conventional changelog specification.

Thanks for the info. The current parse-changelog requires all versions to have the same heading level (it does not care whether it is h2 or h3 or others), but the latest version of conventional-changelog does the same thing.

• https://github.com/conventional-changelog/conventional-changelog/releases/tag/conventional-changelog-conventionalcommits-v5.0.0

  always use H2 heading for versions (fix!: always use H2 heading for versions conventional-changelog/conventional-changelog#920)

• conventional-changelog-conventionalcommits: Patch version headings shouldn’t be a different size conventional-changelog/conventional-changelog#867

Therefore, changelogs following the latest conventional-changelog should already be supported by the parse-changelog.

[taiki-e]

Therefore, changelogs following the latest conventional-changelog should already be supported by the parse-changelog.

Hmm, conventional-changelog-conventionalcommits based on that rule has been released, but conventional-changelog does not seem to have been released yet? (conventional-changelog/conventional-changelog#940)

[kirrg001]

It's good to hear that conventional changelog changed the heading to always H2. That is great.

We are somehow using an older version of conventional-changelog
conventional-changelog/conventional-changelog@3d79263

We will try to update to get the newer version to avoid having h1 headings. This is unrelated to this topic.

The parser would need to support the Lerna conventional changelog format which uses e.g. titles with anchors based on tags. Or the parser returned too many lines, which was unexpected (e.g. when the title was # 2.7.0 (2022-08-31)

Download our latest CHANGELOG and run:

Change heading for 2.7.0 to ##

$ parse-changelog ./CHANGELOG.md 2.7.0
error: not found release note for '2.7.0'

Change the 2.7.0 to ## 2.7.0 - 2022-08-31

$ parse-changelog ./CHANGELOG.md 2.7.0
....

Works

[taiki-e]

Change heading for 2.7.0 to ##

$ parse-changelog ./CHANGELOG.md 2.7.0
error: not found release note for '2.7.0'

This is a bug of parse-changelog that doesn't handle the inline link in the title properly, and I have a fix in dev branch of parse-changelog.

[kirrg001]

Cool 👍

I can test both changes (github_ref & inline link fix) when you are ready. Let me know

[taiki-e]

Published 1.6.0 which includes this changes (token and ref input option) and the inline link fix.

[kirrg001]

I have tested the changes. They work. Thanks!
The only problem we still have is that our changelog contains H1 headlines (instead of h2/h3).
lerna/lerna#3324