fix: handle missing git repo gracefully in github-metadata plugin#127
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
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.
Summary
jekyll-github-metadataplugin previously panicked when it couldn't determine the current repository (e.g. when the site source isn't a git repo, or has no GitHub remote)What changed
plugins/github_metadata.go: BothgetCurrentRepoandgetGitHubRepoerrors are now caught, logged as warnings, and the plugin returnsnilto allow the build to proceed.Repro
Before this fix, building a site that uses
github-pagesplugin from a non-git directory (e.g. a tarball download) caused a panic:After this fix:
Test plan
go test ./...— all tests pass