ruby-lsp
ruby-lsp copied to clipboard
Use Netlify to build documentation preview for PRs
Motivation
Currently, to review a documentation change, one needs to:
- Pull the change and checkout to it with
ghcommand - Run
cd jekyll - Run
bundle exec jekyll serve
And it's assuming that Jekyll is already installed to the latest version locally.
If we can have a way to preview the doc changes directly, it'd be much easier for maintainers and anyone who's interested in the changes to review. And hopefully lowering the reviewing costs can also make doc contribution (feel) easier.
Implementation
- Use Ruby 3.3.3 for
jekyllfolder. I explained more in the comments below. - Add
netlify.tomlto store all build configurations.
With the build ignore config in place, Netlify's free plan should cover our current usages.
Automated Tests
Manual Tests
Deploy Preview for ruby-lsp ready!
| Name | Link |
|---|---|
| Latest commit | ba4b2b0161c0e4d21b16843fbf044b9c277eb8a2 |
| Latest deploy log | https://app.netlify.com/sites/ruby-lsp/deploys/66fc577306886c0008babe78 |
| Deploy Preview | https://deploy-preview-2646--ruby-lsp.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
This pull request is being marked as stale because there was no activity in the last 2 months
Since Netlify's usage at Shopify is still not approved, I'm closing this now.