Sync brew.sh website theme#435
Open
MikeMcQuaid wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Syncs the shared Jekyll theme assets used across Homebrew documentation websites by sourcing the theme from Homebrew/brew.sh during the shared-config sync workflow, while keeping brew.sh and formulae.brew.sh rooted at the site root and syncing other sites under docs/.
Changes:
- Adds an additional
actions/checkoutto fetch selected theme paths fromHomebrew/brew.shfor use during sync. - Extends
shared-config.rbto accept an optionalbrew.shsource path and copy theme directories/files into the correct site root (/ordocs/), preserving file modes. - Prevents theme paths from being copied via the existing Homebrew/brew docs sync path.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/workflows/sync-shared-config.yml | Checks out Homebrew/brew.sh (sparse) and passes it into the sync script as an additional source. |
| .github/actions/sync/shared-config.rb | Adds optional theme sync logic from a brew.sh working copy and adjusts docs syncing to avoid duplicating theme files. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MikeMcQuaid
force-pushed
the
sync-brewsh-theme
branch
from
2222f16 to
de1e86e
Compare
- Copy shared Jekyll theme files from `Homebrew/brew.sh`. - Keep `brew.sh` and `formulae.brew.sh` rooted at the site root. - Sync other documentation sites into their `docs` directory. - Preserve copied file modes so `bin/jekyll` remains executable. - Expand input paths before `chdir` so local syncs are stable. - Avoid copying theme files through the existing docs sync path. - Run sync script style checks in their own workflow job. - Keep checkout sparse patterns compatible with cone mode. - Prune blog assets when copying shared image files. - Fail fast when required sync script arguments are missing.
MikeMcQuaid
force-pushed
the
sync-brewsh-theme
branch
from
de1e86e to
47e31e8
Compare
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.
Depends on Homebrew/brew.sh#1305
Homebrew/brew.sh.brew.shandformulae.brew.shrooted at the site root.docsdirectory.bin/jekyllremains executable.chdirso local syncs are stable.