Use Netlify to build documentation preview for PRs #2646
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
st0012
force-pushed
the
integrate-with-netlify
branch
from
0d77eb0
to
cd7fdb9
Compare
✅ Deploy Preview for ruby-lsp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
st0012
force-pushed
the
integrate-with-netlify
branch
9 times, most recently
from
2b5284b
to
aa76659
Compare
Because Netlify uses rvm, Ruby 3.3.4+ currently fails to build on its containers due to: - ruby/bigdecimal#297 - rubygems/rubygems#8015 And because Netlify doesn't allow installing apt packages, we can't address the issue to make the install succeed. So instead, we need to use a version of Ruby that can be built on Netlify's containers.
st0012
force-pushed
the
integrate-with-netlify
branch
from
0787ec5
to
e8da83d
Compare
st0012
commented
Oct 1, 2024
| @@ -1 +0,0 @@ | |||
| ../.ruby-version | |||
There was a problem hiding this comment.
We need to stay 3.3.3 for now because Netlify uses rvm, which Ruby 3.3.4+ currently fails to build on its
containers due to:
- bigdecimal install error ruby/bigdecimal#297
- gem installation failure with clang and gcc rubygems/rubygems#8015
And because Netlify doesn't allow installing apt packages, we can't address the issue to make the install succeed. So instead, we need to use a version of Ruby that can be built on Netlify's containers.
|
|
||
| # Set the baseurl to "/" and url to "$DEPLOY_PRIME_URL" so that the built site is served from the root | ||
| command = """ | ||
| printf "url: \"$DEPLOY_PRIME_URL\"\nbaseurl: \"/\"" > _config_netlify.yml; \ |
There was a problem hiding this comment.
Since we want to build new sites for PR preview, the url will vary PR by PR. So this line is needed to dynamically generate suitable Jekyll configs for Netlify.
And because it needs to be dynamic, it can't be a committed _config_netlify.yml file.
st0012
changed the title
andyw8
approved these changes
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Currently, to review a documentation change, one needs to:
ghcommandcd jekyllbundle exec jekyll serveAnd 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
jekyllfolder. I explained more in the comments below.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