Skip to content

docs: add testing documentation #1839

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 4 commits into from
May 15, 2023
Merged

Conversation

MarcL
Copy link
Contributor

@MarcL MarcL commented Dec 16, 2022

Summary

Add documentation to run the tests and clarify the need for a Netlify authentication token.

Test plan

N/A

Relevant links (GitHub issues, Notion docs, etc.) or a picture of cute animal

image

Standard checks:

  • Add docs when necessary

@MarcL MarcL requested a review from a team December 16, 2022 10:47
@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for netlify-plugin-nextjs-nx-monorepo-demo ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/netlify-plugin-nextjs-nx-monorepo-demo/deploys/6461d38c95115800089a23f7
😎 Deploy Preview https://deploy-preview-1839--netlify-plugin-nextjs-nx-monorepo-demo.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for netlify-plugin-nextjs-export-demo ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/netlify-plugin-nextjs-export-demo/deploys/6461d38c19b844000871f659
😎 Deploy Preview https://deploy-preview-1839--netlify-plugin-nextjs-export-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for netlify-plugin-nextjs-static-root-demo ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/netlify-plugin-nextjs-static-root-demo/deploys/6461d38cea12bc000809a7ee
😎 Deploy Preview https://deploy-preview-1839--netlify-plugin-nextjs-static-root-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for netlify-plugin-nextjs-next-auth-demo ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/netlify-plugin-nextjs-next-auth-demo/deploys/6461d38cdd09d6000841ede1
😎 Deploy Preview https://deploy-preview-1839--netlify-plugin-nextjs-next-auth-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for next-plugin-edge-middleware ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/next-plugin-edge-middleware/deploys/6461d38c95115800089a23fc
😎 Deploy Preview https://deploy-preview-1839--next-plugin-edge-middleware.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for netlify-plugin-nextjs-demo ready!

Name Link
🔨 Latest commit b7dbd76
🔍 Latest deploy log https://app.netlify.com/sites/netlify-plugin-nextjs-demo/deploys/63d8ef6bc92aff0009f0a4d1
😎 Deploy Preview https://deploy-preview-1839--netlify-plugin-nextjs-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for nextjs-plugin-custom-routes-demo ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/nextjs-plugin-custom-routes-demo/deploys/6461d38c19b844000871f65f
😎 Deploy Preview https://deploy-preview-1839--nextjs-plugin-custom-routes-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for next-i18next-demo ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/next-i18next-demo/deploys/6461d38cea12bc000809a7f3
😎 Deploy Preview https://deploy-preview-1839--next-i18next-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Dec 16, 2022

Deploy Preview for next-plugin-canary ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/next-plugin-canary/deploys/6461d38cab37d90008cb949f
😎 Deploy Preview https://deploy-preview-1839--next-plugin-canary.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

README.md Outdated
Then run the E2E tests:

```shell
NETLIFY_AUTH_TOKEN=your-token-here npm test:next
Copy link
Contributor

Choose a reason for hiding this comment

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

This might change anyway, based on @ascorbic's comment about passing in a site ID, but you missed the 'run' from npm run test:next

Copy link

@ericapisani ericapisani Dec 16, 2022

Choose a reason for hiding this comment

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

@orinokai In this case the 'run' isn't necessary because npm aliases it - https://docs.npmjs.com/cli/v8/commands/npm-test

Copy link
Contributor

Choose a reason for hiding this comment

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

That works for npm test, but not npm test:next etc

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For my reference, Matt's comment about site ID

You can pass in a site ID as an env var for the tests

ericapisani
ericapisani previously approved these changes Dec 16, 2022
Copy link

@ericapisani ericapisani left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

README.md Outdated
Then run the E2E tests:

```shell
NETLIFY_AUTH_TOKEN=your-token-here npm test:next
Copy link

@ericapisani ericapisani Dec 16, 2022

Choose a reason for hiding this comment

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

@orinokai In this case the 'run' isn't necessary because npm aliases it - https://docs.npmjs.com/cli/v8/commands/npm-test

@MarcL MarcL force-pushed the marcl/update-docs-for-testing branch from fd316d9 to dc5f3d2 Compare January 31, 2023 10:36
@MarcL
Copy link
Contributor Author

MarcL commented Jan 31, 2023

Updated the npm command and clarified how to deploy to your own site. Let me know if it's good to go. Thanks.

@netlify
Copy link

netlify bot commented May 15, 2023

Deploy Preview for netlify-plugin-nextjs-demo ready!

Name Link
🔨 Latest commit 013602c
🔍 Latest deploy log https://app.netlify.com/sites/netlify-plugin-nextjs-demo/deploys/6461d38cab37d90008cb94a4
😎 Deploy Preview https://deploy-preview-1839--netlify-plugin-nextjs-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@kodiakhq kodiakhq bot merged commit 4e70c63 into main May 15, 2023
@kodiakhq kodiakhq bot deleted the marcl/update-docs-for-testing branch May 15, 2023 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants