Skip to content

fix(@angular/cli): fix relative link to README not working on npm repo #29496

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

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

skander23000
Copy link
Contributor

The link to the README was relative, which caused it to break when viewed on the npm repository. The link has been updated to an absolute URL to ensure it works properly.

Closes #29489

PR Checklist

Please check to confirm your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • [x ] Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • [ x] No

Other information

The link to the README was relative, which caused it to break when viewed on the npm repository. The link has been updated to an absolute URL to ensure it works properly.

Closes angular#29489
@alan-agius4 alan-agius4 added action: merge The PR is ready for merge by the caretaker merge: fix commit message When the PR is merged, rewrites/fixups of the commit messages are needed labels Jan 28, 2025
Copy link
Collaborator

@alan-agius4 alan-agius4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution.

@alan-agius4 alan-agius4 added target: patch This PR is targeted for the next patch release merge: squash commits When the PR is merged, a squash and merge should be performed labels Jan 28, 2025
@alan-agius4 alan-agius4 merged commit 6f9a764 into angular:main Jan 28, 2025
35 checks passed
@alan-agius4
Copy link
Collaborator

The changes were merged into the following branches: main, 19.1.x

alan-agius4 pushed a commit that referenced this pull request Jan 28, 2025
The link to the README was relative, which caused it to break when viewed on the npm repository. The link has been updated to an absolute URL to ensure it works properly.

(cherry picked from commit 6f9a764)
@skander23000
Copy link
Contributor Author

skander23000 commented Jan 28, 2025

It doesn't fix the bug in the npm repo :( The link is not updated.
It is still pointing to '../../../README.md' instead of the correct one: 'https://github.com/angular/angular-cli/blob/main/README.md'.

Is the npm repo updated when the GitHub repo is? @alan-agius4

Capture d’écran du 2025-01-28 11-17-17

@andreas-aeschlimann
Copy link

andreas-aeschlimann commented Jan 28, 2025

As I mentioned in my issue, something weird is going on. The link never was relative on NPM, even though it was in Git.

I suspect that some script that we cannot see in the repo manipulates the URL before publishing to NPM.

@alan-agius4
Copy link
Collaborator

This still needs to be released on NPM.

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Feb 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker area: @angular/cli merge: fix commit message When the PR is merged, rewrites/fixups of the commit messages are needed merge: squash commits When the PR is merged, a squash and merge should be performed target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken link on NPM ReadMe text
3 participants