Skip to content

changelog links are broken #16727

Closed
Closed

Description

@fz6m

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

Activity

  1. bluwy commented on May 27, 2024

    @bluwy
    Member

    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.

  2. added
    p1-choreDoesn't change code behavior (priority)
    on May 27, 2024
  3. btea commented on Jul 4, 2024

    @btea
    Contributor

    @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.

  4. bluwy commented on Jul 17, 2024

    @bluwy
    Member

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

  5. btea commented on Jul 17, 2024

    @btea
    Contributor

    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.

  6. bluwy commented on Jul 17, 2024

    @bluwy
    Member

    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.

  7. bluwy commented on Jul 22, 2024

    @bluwy
    Member

    I think we can close this with #17709 merged

  8. locked and limited conversation to collaborators on Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationp1-choreDoesn't change code behavior (priority)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions