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

Move CI build cache instructions to Deployment docs #35418

Merged
merged 7 commits into from
May 13, 2022
Merged

Move CI build cache instructions to Deployment docs #35418

merged 7 commits into from
May 13, 2022

Conversation

htunnicliff
Copy link
Contributor

@htunnicliff htunnicliff commented Mar 17, 2022

This PR moves the instructions for configuring CI providers to preserve Next.js's build cache out of the No Cache Detected error message and into the Deployment a new page within the Advanced Features docs.

This change is beneficial because it makes the CI configuration examples visible in the context of other helpful documentation for deploying Next.js.

👉 Prior to this change, these CI configuration examples didn't show up in the Next.js docs.

The relocated instructions are now linked on the No Cache Detected error message page.

Documentation / Examples

  • Make sure the linting passes by running yarn lint

@htunnicliff htunnicliff changed the title Move CI build cache instructions to deployment docs Move CI build cache instructions to Deployment docs Mar 17, 2022
styfle
styfle previously approved these changes Mar 18, 2022
Copy link
Member

@styfle styfle 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

@leerob leerob left a comment

Choose a reason for hiding this comment

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

Agreed that we want to surface these steps outside of the errors page (good catch!) but we'll want to either:

  1. Move this into its own page (it's long)
  2. Condense and link to instructions from providers (I worry these are already out of date)

We're working to restructure this page of the docs as well, so let me think about this a bit more while we figure that out. Appreciate the contribution.

@htunnicliff
Copy link
Contributor Author

@leerob that makes a lot of sense.

I wonder if it would be helpful to add a provider-agnostic strategy for invalidating .next/cache? If that strategy was defined here, it could make these docs more evergreen since users could refer to provider-specific docs with the intended invalidation strategy in mind.

E.g. "invalidate the Next.js cache if dependencies change or source files change" etc.

@htunnicliff
Copy link
Contributor Author

Hey @leerob! Do you think it would be alright in the meantime to have this update go through as is? Reason being that folks can still benefit from this information being in the docs, even if it is eventually reorganized.

Right now, this info doesn't exist in the docs anywhere, so just adding it in the first place would be really helpful.

@leerob
Copy link
Member

leerob commented Apr 4, 2022

  • Let's make it a separate page "Advanced Features -> CI Build Caching"
  • Update the link in the errors page to use this new page

@htunnicliff htunnicliff requested a review from leerob April 5, 2022 21:48
@htunnicliff
Copy link
Contributor Author

@leerob I was able to incorporate your requested changes – feel free to take a look and merge whenever you are ready!

@htunnicliff
Copy link
Contributor Author

@leerob / @timneutkens – I think this PR is ready to go! 🚀

Please let me know if there are any other changes I should make!

@htunnicliff
Copy link
Contributor Author

Hi folks! Would you like me to close this PR? It has been several months and I haven't heard from anyone, so I'll plan on closing this PR a week from today if there is no word.

leerob
leerob previously approved these changes May 11, 2022
Copy link
Member

@leerob leerob left a comment

Choose a reason for hiding this comment

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

Thank you! Sorry for the delay.

Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Thanks!

@styfle styfle requested a review from leerob May 12, 2022 18:13
@styfle styfle merged commit 521f88e into vercel:canary May 13, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants