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

changelog links are broken #16727

Closed
2 of 4 tasks
fz6m opened this issue May 20, 2024 · 6 comments
Closed
2 of 4 tasks

changelog links are broken #16727

fz6m opened this issue May 20, 2024 · 6 comments
Labels
documentation Improvements or additions to documentation p1-chore Doesn't change code behavior (priority)

Comments

@fz6m
Copy link

fz6m commented May 20, 2024

Documentation is

  • Missing
  • Outdated
  • Confusing
  • Not sure?

Explain in Detail

I often check the changelog, but this time many links were broken 🥲

See

CleanShot 2024-05-21 at 0  49 16

Your Suggestion for Changes

Add PR link

Reproduction

No response

Steps to reproduce

No response

@fz6m fz6m added the documentation Improvements or additions to documentation label May 20, 2024
@bluwy
Copy link
Member

bluwy commented May 27, 2024

We probably need to use the full commit hash in the linked url - conventional-changelog/conventional-changelog#476

However the linked issue doesn't seem to have a direct solution, and I haven't investigated if we can tweak this directly. Strangely though, the short commit hash shouldn't be colliding since it's displaying fine for me locally:

> git rev-parse 82111bf  
82111bfb4134646f5ea03a6bead16ebdf67bbe15

A shorter hash would look like:

> git rev-parse 8211     
error: short object ID 8211 is ambiguous
hint: The candidates are:
hint:   82111bfb4 commit 2024-05-20 - fix: types
hint:   82116a58c tree
hint:   8211f8632 blob
8211
fatal: ambiguous argument '8211': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'

Maybe GitHub collects more hashes not cloned locally.

@bluwy bluwy added the p1-chore Doesn't change code behavior (priority) label May 27, 2024
@btea
Copy link
Collaborator

btea commented Jul 4, 2024

@bluwy It seems that the upstream has not planned to solve this problem for a long time. Perhaps we can add a script to replace the short hash with the full hash value.

@bluwy
Copy link
Member

bluwy commented Jul 17, 2024

Fine by me 👍 Maybe we can also use pnpm to patch it.

@btea
Copy link
Collaborator

btea commented Jul 17, 2024

conventional-changelog is called directly with npx, and I don't know how to patch it. Currently, I can only write a script to update the hash value.

@bluwy
Copy link
Member

bluwy commented Jul 17, 2024

If you want to patch, you can use https://pnpm.io/cli/patch, e.g. pnpm patch conventional-changelog-cli. Though I'm not sure if that's the code we want to edit, you could also pass a nested package name to edit.

@bluwy
Copy link
Member

bluwy commented Jul 22, 2024

I think we can close this with #17709 merged

@bluwy bluwy closed this as completed Jul 22, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation p1-chore Doesn't change code behavior (priority)
Projects
None yet
Development

No branches or pull requests

3 participants