osteele / osteele/gojekyll

jekyll-github-metadata: support GitHub Enterprise configuration

Open
#134 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

github-pages plugins
Dominant language
Go
Stars
394
Forks
21
PR merge metrics
No merged PRs in 30d

Description

Summary

Add GitHub Enterprise and Octokit-compatible endpoint configuration to jekyll-github-metadata.

Scope

  • configurable API and web endpoints instead of hard-coded github.com values
  • token/environment precedence compatible with the Ruby plugin where practical
  • correct archive, owner, repository, and help URLs on Enterprise hosts
  • validation that credentials are never included in diagnostics or cache keys
  • tests against a local HTTP server, including custom base paths
  • user-facing configuration documentation

Keep this separate from missing scalar and collection fields so endpoint/authentication policy can be reviewed independently.

Split from #28.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the jekyll-github-metadata configuration and endpoint/authentication handling, then review the existing tests and documentation. Add coverage using a local HTTP server, including custom base paths, and update the user-facing configuration documentation. Done means Enterprise archive, owner, repository, and help URLs work without exposing credentials in diagnostics or cache keys.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, go
Domain
api, documentation, security
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.