Cork Theme

• Upsteam SASS
• Patternlab

Merging Campus (IET) Styles

Our styles are built on top of IET's SiteFarm styles. When there are upstream changes, follow these steps to bring IET's changes into ours.

1. Check for updates

git switch main
git pull
./devops/cmds/check-upstream-styles.sh

This saves any new campus changes to the dedicated vendor branch (upstream-styles) and prints a report. It is safe to run as often as you like, and it never changes our own code.

If it says Up to date, you're done.

2. Read the report

• Campus updates: what campus changed, in their own words.
• Files campus changed: pay extra attention to anything renamed or deleted.
• Files we customised that campus also changed: make sure our edits still make sense.
• Merge preview: which files, if any, will need fixing by hand.

3. Share the update

git push origin upstream-styles

This simply updates the vendor branch in Github.

4. Merge

./devops/cmds/merge-upstream-styles.sh

If some files need fixing by hand, the script tells you which ones and how. To back out at any point before finishing, run git merge --abort.

5. Rebuild and review

Rebuild everything generated from the styles, such as the compiled CSS and the Lit css.js modules. The local dev container must be running.

./devops/cmds/run-package-tool.sh styles run-all

You can verify what changed with:

git status
git diff --stat

Look over what changed in services/package/styles/ before committing. This is where problems the merge can't detect show up, such as a renamed class or a new rule that overrides one of ours.

6. Add, Commit, and Push

Now, commit and push all changes to the main branch.

Notes

• When we change a campus style file, we wrap our edit in comments so it's easy to spot:

  // ucdlib-edit-start: why we changed this
  ...
  // ucdlib-edit-end

• Every campus update is recorded in docs/upstream-styles-log.md.