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

Fixed YAML valid date error #48

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

noah-ku
Copy link

@noah-ku noah-ku commented Feb 13, 2024

There is an error that is thrown when trying to host this template using GitHub pages, and I fixed it by adding vendor to the exclude list in the _config.yml. Here are more details on the error I got. Just a small fix, but hope it helps!

@kevinlin1
Copy link
Owner

Thanks for submitting this pull request. I'm trying to understand the extent of the problem before I merge.

I just tried upgraded to ruby 3.1.0 (debian bookworm) and re-installed my bundler fresh following the GitHub Pages setup instructions. As far as I'm aware, this documentation does not recommend configuring the Bundler install path to produce a vendor subdirectory inside of your project folder—which seems to be the cause of the problem suggested by your fix. Since users can set any local path name (like vendor or anything else they prefer), they would also need to reconfigure this line accordingly. I'm hesitant to merge this pull request as a result.

@noah-ku
Copy link
Author

noah-ku commented Feb 13, 2024

Sorry for not clarifying earlier, I think this error comes up when the page is deployed using GitHub Actions under the Pages section rather than using a branch directly, which means a jekyll.yml gets created in the .github folder. The Jekyll workflow/package uses the default vendor subdirectory and creates some problems with the default template. I think this problem is really specific and might not apply to everyone so no worries if it doesn't get pulled!

Here are some screenshots for reference:

Screenshot 2024-02-13 at 10 55 06 AM Screenshot 2024-02-13 at 10 54 50 AM

@kevinlin1
Copy link
Owner

kevinlin1 commented Feb 13, 2024

I see, thanks for the quick response. I haven't tested this template with anything but the classic GitHub Pages gem: Just the Docs is designed to run on the classic, highly restricted build environment.

Jekyll also ignores certain subdirectories that are prefixed with an underscore, so that could be a more customizable way for GitHub Actions support: setup the vendor dependencies in an underscore-prefixed directory so that it gets automatically ignored. This could be something that we add to the README.md file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants