Allow user to set empty baseurl #97
Merged
Conversation
This file contains hidden or 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
2 tasks
2 tasks
|
The route I'd like to take is to change the default in Jekyll from |
parkr
added a commit
to jekyll/jekyll
that referenced
this pull request
Jun 14, 2017
Using an empty string as the default value causes all sorts of problems where you don't know if this is user-specified or not. Using an explicitly "illegal" value, like `nil`, resolves this issue. See jekyll/github-metadata#97 for more info.
|
I have a PR here: jekyll/jekyll#6137 |
|
v3.4.4 is now released with this patch! |
parkr
reviewed
Jun 19, 2017
| let(:user_config) { { "baseurl" => "/" } } | ||
|
|
||
| it "mangles site.url" do | ||
| expect(site.config["baseurl"]).to eql("/github-metadata") |
There was a problem hiding this comment.
That was the original logic.
- Scenario 1: Users incorrectly set their baseurl as
/ - Scenario 2: A sophisticated user is proxying their site and wants their baseurl to be
/despite it being a project page
I'd lean towards mangling, as in scenario 1, the user needs our help more than the user in scenario 2.
|
@parkr with 3.4.5 out, I believe this is ready for 👀. |
parkr
requested changes
Jul 17, 2017
| Jekyll::Commands::Build.process({ | ||
| "source" => SOURCE_DIR.to_s, | ||
| "destination" => DEST_DIR.to_s, | ||
| "gems" => %w(jekyll-github-metadata), |
There was a problem hiding this comment.
This only works for Jekyll::VERSION >= 3.5.0.
parkr
approved these changes
Jul 17, 2017
|
@jekyllbot: merge |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Via github/pages-gem#350 (comment), it's currently not possible to set a baseurl of "" that the Gem respects.
github-metadata/lib/jekyll-github-metadata/site_github_munger.rb
Line 44 in 40a725a
The problem is that by default, Jekyll sets the baseurl to "", not nil, meaning there's no way to know if it's a user-supplied value or not.
One option would be to respect
site.github.urlorsite.github.baseurlif passed.This PR pushes up a failing test and passing tests for the current expected behavior.
If anyone has a better approach, or would like to take a pass at implementing the above, it may be a while before I am able to work on this particular PR.