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

.md only: npm init astro --> npm create astro #4760

Merged
merged 2 commits into from
Sep 16, 2022

Conversation

mrienstra
Copy link
Contributor

Changes

For consistency with withastro/docs#360. Docs always use npm create astro (never npm init astro), README.md files in this repo should do the same.

Search:
\b(npm|yarn|pnpm) init astro\b
Replace:
$1 create astro

Except for two instances:

  1. packages/create-astro/CHANGELOG.md -- skipped because changelog.

  2. packages/create-astro/test/create-astro.test.js.skipped -- skipped, old test file disabled in Feat: [create astro] add directory prompt #3168.

Q: should I run pnpm exec changeset for minor changes only touching *.md files? I would guess no.

Testing

n/a, no code changes.

Docs

n/a, changes make README.md files consistent with docs, see above.

For consistency with withastro/docs#360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same.

Search:
`\b(npm|yarn|pnpm) init astro\b`
Replace:
`$1 create astro`

Except for two instances:

1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog.

2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in withastro#3168.
@mrienstra mrienstra requested a review from a team as a code owner September 14, 2022 20:38
@changeset-bot
Copy link

changeset-bot bot commented Sep 14, 2022

⚠️ No Changeset found

Latest commit: 6c1dd4e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added pkg: create-astro Related to the `create-astro` package (scope) pkg: example Related to an example package (scope) labels Sep 14, 2022
Copy link
Contributor

@matthewp matthewp left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

Should we recommend @latest too? Since npm create always prefers the cache (for some reason). e.g. npm create astro@latest -- --template with-mdx (The docs seem to follow this too)

Co-authored-by: Bjorn Lu <bjorn@bjornlu.com>
Copy link
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for making the change.

@mrienstra
Copy link
Contributor Author

Looks great! Thanks for making the change.

Thank you for catching that! 😅

@natemoo-re natemoo-re merged commit a800bf7 into withastro:main Sep 16, 2022
@mrienstra mrienstra deleted the patch-1 branch September 19, 2022 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: create-astro Related to the `create-astro` package (scope) pkg: example Related to an example package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants