Skip to content

chore(router): copy README file from workspace root #2502

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

Closed
wants to merge 1 commit into from

Conversation

Kshao123
Copy link

add README to make the package look less bare on npm

https://docs.npmjs.com/about-package-readme-files

1

Copy link

netlify bot commented May 21, 2025

Deploy Preview for vue-router canceled.

Name Link
🔨 Latest commit 2ef2409
🔍 Latest deploy log https://app.netlify.com/projects/vue-router/deploys/682de4a40f9d0e00083b8cc1

Copy link
Contributor

@skirtles-code skirtles-code left a comment

Choose a reason for hiding this comment

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

This used to be handled in release.mjs, but it seems that was removed in e03edfd. Unclear whether that was intentional. Maybe the plan was to handle this like Pinia, which uses a separate, shorter version of its README.md for the npm release?

Not sure which approach posva would prefer for Vue Router.

Comment on lines +108 to +109
"prepack": "cp ../../README.md ./README.md",
"postpack": "rm ./README.md"
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think using cp and rm is portable. The package rimraf is already included, which is a portable version of rm. In the past I've used the copyfiles package as a portable replacement for cp.

Copy link
Member

@posva posva left a comment

Choose a reason for hiding this comment

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

@skirtles-code is right, this was an oversight when updating the release script. It should be moved there like it used to be

@github-project-automation github-project-automation bot moved this to 🆕 Triaging in Vue Router Roadmap Jun 4, 2025
@posva posva moved this from 🆕 Triaging to 🧑‍💻 In progress in Vue Router Roadmap Jun 4, 2025
@posva posva closed this in e48d1c3 Jun 6, 2025
@github-project-automation github-project-automation bot moved this from 🧑‍💻 In progress to ✅ Done in Vue Router Roadmap Jun 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants