Automate microsite deployment with build script and GitHub Actions #81
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
- Create build script (scripts/build_microsite.py) to generate microsite with commit hash - Create GitHub Actions workflow (.github/workflows/deploy-pages.yml) for automated deployment - Split docs/index.html into docs/index.template.html (source) and generated output - Add commit hash display to microsite header - Update .gitignore to exclude generated docs/index.html - Update docs/README.md with build and deployment documentation Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>
- Update main README.md with live site link and build info - Add comprehensive BUILD_SYSTEM.md documentation - Document the automated build and deployment process Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>
- Remove docs/index.html from git tracking (it's generated during deployment) - Add detailed checklist for keeping CLI and microsite code in sync - Improve BUILD_SYSTEM.md with specific guidance on maintaining consistency Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add GitHub action to deploy latest BadgeSort code
Automate microsite deployment with build script and GitHub Actions
Oct 28, 2025
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.
The microsite at
/docs/index.htmlrequired manual synchronization with the main application code whenever badge generation or sorting logic changed, creating maintenance burden and drift risk.Changes
Build System
scripts/build_microsite.py: Generatesdocs/index.htmlfrom template, injecting commit hashdocs/index.template.html: Source template with{{COMMIT_HASH}}placeholder (tracked in git)docs/index.html: Now generated during deployment (excluded from git via.gitignore)Deployment Pipeline
.github/workflows/deploy-pages.yml: Builds and deploys to GitHub Pages on push to maindocs/**,badgesort/**, or build scriptsDocumentation
docs/BUILD_SYSTEM.md: Architecture, sync checklists for keeping CLI/microsite algorithms aligneddocs/README.md: Build and deployment workflowREADME.md: Live site link athttps://chipwolf.github.io/BadgeSort/Result
Microsite automatically rebuilds and deploys on every push. Commit hash visible on live site for version transparency.
Setup Required
Repository Settings → Pages → Source: "GitHub Actions" (not branch-based)
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.