Skip to content
This repository has been archived by the owner on Jun 24, 2022. It is now read-only.

🌐 Website Issue | GitHub Repo Info Missing on Production Build #2232

Open
thatrobotdev opened this issue Mar 14, 2021 · 2 comments · May be fixed by #2311 or #2293
Open

🌐 Website Issue | GitHub Repo Info Missing on Production Build #2232

thatrobotdev opened this issue Mar 14, 2021 · 2 comments · May be fixed by #2311 or #2293
Labels
todo 🌐 website issue *Technical* issues with the website.

Comments

@thatrobotdev
Copy link
Contributor

thatrobotdev commented Mar 14, 2021

Description

Builds are failing in Netlify when building a production build with jekyll (JEKYLL_ENV=production bundle exec jekyll build). This is because the GitHub Metadata plugin requires a repository to be set (https://github.com/jekyll/github-metadata/blob/master/docs/configuration.md).

This causes local builds to succeed and production builds to fail (like https://app.netlify.com/sites/privacytools-io/deploys/604d1c4b235d000008111252).

To fix this, from the GitHub Metadata docs:

In order for jekyll-github-metadata to know what metadata to fetch it must
be able to determine the repository NWO (name with owner, e.g. jekyll/jekyll-github-metadata) to ask GitHub about.

The easiest way to accomplish this is by setting an "origin" remote with a
github.com URL. If you ran git clone from GitHub, this is almost 100% the
case & no further action is needed. If you run git remote -v in your
repository, you should see your repo's URL.

If you don't have a git remote available, you have two other options:

  1. Set the environment variable PAGES_REPO_NWO to your repository name
    with owner, e.g. "jekyll/github-metadata". This is useful if you don't
    want to commit your repository to your git history.
  2. Add your repository name with organization to your site's configuration
    in the repository key.
repository: username/repo-name

"NWO" stands for "name with owner." It is GitHub lingo for the username of
the owner of the repository plus a forward slash plus the name of the
repository, e.g. 'parkr/blog', where 'parkr' is the owner and 'blog' is the
repository name.

Your site.github.* fields should fill in like normal. If you run Jekyll
with the --verbose flag, you should be able to see all the API calls
made.

Screenshots

screenshot of netlify production build failure

screenshot of local build failure

@thatrobotdev thatrobotdev added the 🌐 website issue *Technical* issues with the website. label Mar 14, 2021
@freddy-m freddy-m added the todo label Mar 15, 2021
@lrq3000
Copy link
Contributor

lrq3000 commented May 15, 2021

Could someone fix this please? All my builds failed and it was not trivial to understand why (because it could have been formatting errors). I can't provide a netlify URL for my PRs until this is resolved.

@lrq3000 lrq3000 linked a pull request May 15, 2021 that will close this issue
3 tasks
lrq3000 added a commit to lrq3000/privacytools.io that referenced this issue May 15, 2021
Signed-off-by: Stephen L. <[email protected]>
@lrq3000
Copy link
Contributor

lrq3000 commented May 15, 2021

I fixed the issue in #2293 by adding a repository: privacytools/privacytools.io parameter in _config.yml. Merging this PR should fix the issue for all other PRs I guess.

lrq3000 added a commit to lrq3000/privacytools.io that referenced this issue May 31, 2021
…itory info in _config.yml

Signed-off-by: Stephen L. <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
todo 🌐 website issue *Technical* issues with the website.
Projects
None yet
3 participants