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.

Sign up for GitHub

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

Jump to bottom

Docs: Fix formatting in testing docs and update examples dependencies #59572

Merged
merged 6 commits into from
Dec 13, 2023
Merged

Docs: Fix formatting in testing docs and update examples dependencies #59572

merged 6 commits into from
Dec 13, 2023

Conversation

delbaoliveira
Copy link
Contributor

@delbaoliveira delbaoliveira commented Dec 13, 2023 •
edited
Loading

Follow-up from: #59268

@delbaoliveira delbaoliveira requested review from a team as code owners December 13, 2023 13:45
@delbaoliveira delbaoliveira requested review from manovotny and lydiahallie and removed request for a team December 13, 2023 13:45
@ijjk ijjk added area: documentation examples Issue/PR related to examples created-by: Next.js Docs team PRs by the Docs team. labels Dec 13, 2023
@delbaoliveira delbaoliveira changed the title Docs: Polish testing docs, updated example dependencies Docs: Polish testing docs and update /example dependencies Dec 13, 2023
@delbaoliveira delbaoliveira changed the title Docs: Polish testing docs and update /example dependencies Docs: Fix formatting in testing docs and update /example dependencies Dec 13, 2023
@delbaoliveira delbaoliveira changed the title Docs: Fix formatting in testing docs and update /example dependencies Docs: Fix formatting in testing docs and update examples dependencies Dec 13, 2023
@ijjk ijjk merged commit f518fd8 into canary Dec 13, 2023
33 of 37 checks passed
@ijjk ijjk deleted the docs-f9dj branch December 13, 2023 15:02
@icyJoseph icyJoseph mentioned this pull request Dec 15, 2023
Merged
ijjk added a commit that referenced this pull request Dec 18, 2023
@icyJoseph @ijjk
fix: Invalid next version tag name in with-cypress example (#59647)
7eac1c8 
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

Hi,

Fix for the accidental change, introduced in this PR
#59572, which set the `next`
version tag for the with-cypress example, to `^latest`, which causes the
`create-next-app` step to fail:

```shell
npx create-next-app --example with-cypress with-cypress-app
Creating a new Next.js app in /Users/<user>/<Project-Path>/with-cypress-app.

Downloading files for example with-cypress. This might take a moment.

Installing packages. This might take a couple of minutes.

npm ERR! code EINVALIDTAGNAME
npm ERR! Invalid tag name "^latest" of package "next@^latest": Tags may not have any characters that encodeURIComponent encodes.
```

Yarn instead, shows a list of next.js packages to select from instead.

Co-authored-by: JJ Kasper <jj@jjsweb.site>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@huozhi huozhi huozhi approved these changes

@ijjk ijjk ijjk approved these changes

@manovotny manovotny Awaiting requested review from manovotny manovotny was automatically assigned from vercel/devex

@lydiahallie lydiahallie Awaiting requested review from lydiahallie lydiahallie was automatically assigned from vercel/devex

@leerob leerob Awaiting requested review from leerob

@StephDietz StephDietz Awaiting requested review from StephDietz

Assignees
No one assigned
Labels
created-by: Next.js Docs team PRs by the Docs team. examples Issue/PR related to examples locked
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@delbaoliveira @huozhi @ijjk