feat: auto-deploy index browser + simpler README#5
Merged
Sunrisepeak merged 1 commit intomainfrom May 9, 2026
Merged
Conversation
Adds a `deploy-site` workflow that runs the upstream `xpkgindex` tool
(same as d2learn/xim-pkgindex) on every push to main and publishes
the rendered HTML to GitHub Pages. `.xpkgindex.json` carries the
mcpp-specific branding (title, links, install command template
`mcpp add {name}@{version}`, install snippet pointing at the
mcpp release-asset install.sh).
The README is trimmed to the parts a contributor actually needs:
- One-line description + browse link.
- One-line quickstart (`mcpp add ...` + `mcpp build`).
- Three-line "adding a package" pointer to existing files as
templates and the mcpp ext doc.
- License footer.
The comparison table with xim-pkgindex / mcpplibs-index moved out;
that's a meta-question that belongs in mcpp's docs, not in the
index repo's front door.
Once GitHub Pages is enabled in the repo settings, the workflow
will keep https://mcpp-community.github.io/mcpp-index/ in sync
with main automatically.
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
1 participant
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
Two related improvements to the index repo's hygiene:
.github/workflows/deploy-site.ymlrunsxpkgindex generate(same tool as d2learn/xim-pkgindex) on every push to main and publishes the result to GitHub Pages..xpkgindex.jsonholds mcpp-specific branding: title, links, and an install command template that emitsmcpp add {name}@{version}on each package page.Test plan
xpkgindex generate . --output siteruns cleanly locally; index.html shows the right title andmcpp add lua@5.4.7as the install snippet on the package pageNotes
deploy-siteto actually publish. The workflow itself doesn't fail without it.