Skip to content

feat: Set up for GH pages - #27

Merged
LinKCoding merged 8 commits into
mainfrom
kl-gmt-1797-github-pages
Sep 24, 2026
Merged

LinKCoding merged 8 commits into
mainfrom
kl-gmt-1797-github-pages

Conversation

@LinKCoding

@LinKCoding LinKCoding commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Overview

Set up Gamut Starlight docs and Storybook for deployment to GitHub Pages, with dual-server dev mode for local testing.

PR Checklist

  • Related to designs:
  • Related to JIRA ticket: GMT-1797
  • Changeset added (or empty changeset if no release)
  • I have run this code to verify it works
  • This PR includes unit tests for the code change
  • This PR includes testing instructions tests for the code change
  • Package previews from this PR are passing end-to-end tests in all relevant consuming repositories

Testing Instructions

  1. Run yarn start and verify both Starlight docs (port 3333) and Storybook (port 6006) launch in parallel
  2. Read over new deploy.yml file
  3. ...
  4. Profit?

PR Links and Envs

N/A

@codecov

codecov Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.40%. Comparing base (7b856ec) to head (a219dd0).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #27   +/-   ##
=======================================
  Coverage   91.40%   91.40%           
=======================================
  Files         408      408           
  Lines        6903     6903           
  Branches     2219     2223    +4     
=======================================
  Hits         6310     6310           
  Misses        584      584           
  Partials        9        9           
Flag Coverage Δ
main ?
pull-request 91.40% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@pkg-pr-new

pkg-pr-new Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@skillsoft/eslint-plugin-gamut

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/eslint-plugin-gamut@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/eslint-plugin-gamut@27.tgz

@skillsoft/gamut

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut@27.tgz

@skillsoft/gamut-agent-tools

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-agent-tools@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-agent-tools@27.tgz

@skillsoft/gamut-icons

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-icons@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-icons@27.tgz

@skillsoft/gamut-illustrations

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-illustrations@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-illustrations@27.tgz

@skillsoft/gamut-patterns

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-patterns@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-patterns@27.tgz

@skillsoft/gamut-styles

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-styles@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-styles@27.tgz

@skillsoft/gamut-tests

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-tests@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-tests@27.tgz

@skillsoft/variance

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/variance@27
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/variance@27.tgz

commit: a219dd0

@LinKCoding
LinKCoding marked this pull request as ready for review September 24, 2026 14:08
@LinKCoding
LinKCoding requested a review from a team as a code owner September 24, 2026 14:08
Comment thread .changeset/olive-dogs-report.md Outdated
Comment thread package.json Outdated

@dreamwasp dreamwasp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

couple q's. yolo though

Comment on lines +3 to +6
on:
push:
branches: [main]
workflow_dispatch:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should maybe think about when we want things to get to the Docs website knowing that we will be releasing to from main -> beta -> production. maybe we have diff versions of the site or a dropdown?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Smart, I'll ticket this out!

// sidebar replaces the others instead of all six being stacked in one long list.
export default defineConfig({
site: 'https://gamut.skillsoft.com',
site: 'https://codecademy.github.io',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

skillsoft.gamut.io?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's because the repo is under codecademy, so this is the default for GH pages
will change ASAP after setting up DNS!

@LinKCoding
LinKCoding merged commit d3bc05c into main Sep 24, 2026
20 of 23 checks passed
@LinKCoding
LinKCoding deleted the kl-gmt-1797-github-pages branch September 24, 2026 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants