You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Magic2U uses a suite of GitHub Actions workflows to ensure code quality, accessibility, reliability, and seamless deployment. These workflows automate the most important parts of the engineering lifecycle, allowing contributors to focus on building great experiences.
3
+
Magic2U uses GitHub Actions for product validation. Cloudflare Workers Builds handles production deployment from the `main` branch.
4
4
5
5
This document explains each workflow and how it fits into the Magic2U ecosystem.
6
6
7
7
---
8
8
9
-
#🧪 1. Continuous Integration (CI)
9
+
## 1. Continuous Integration
10
10
11
11
**File:**`.github/workflows/ci.yml`
12
12
**Purpose:** Validate code quality on every push and pull request.
13
13
14
-
CI typically includes:
14
+
The active workflow includes:
15
15
16
16
- TypeScript type checking
17
17
- Linting
18
18
- Unit tests
19
19
- Build verification
20
20
21
-
This ensures that no broken code enters the main branch.
21
+
This is the required product-health check on `main`.
**Purpose:** Prevent accessibility regressions before merging.
@@ -37,36 +37,16 @@ This keeps the design system inclusive and compliant.
37
37
38
38
---
39
39
40
-
# 🚀 3. Deploy Pages (Docs / Storybook)
41
-
42
-
**File:**`.github/workflows/deploy-pages.yml`
43
-
**Purpose:** Automatically deploy documentation or Storybook to GitHub Pages.
44
-
45
-
Typical behavior:
46
-
47
-
- Build the docs or Storybook site
48
-
- Upload the static output
49
-
- Deploy to GitHub Pages
50
-
- Provide preview URLs for PRs
51
-
52
-
This ensures the design system is always documented and accessible.
53
-
54
-
---
55
-
56
-
# 📦 4. Release Automation (Changesets)
40
+
## 3. Release readiness
57
41
58
42
**File:**`.github/workflows/release.yml`
59
-
**Purpose:**Automate versioning and publishing of Magic2U packages.
43
+
**Purpose:**Manually validate a release candidate before publication.
60
44
61
-
This workflow:
45
+
This workflow is started with **Actions → Release Readiness → Run workflow**. It installs dependencies, builds the product, runs lint checks, and runs available tests. It does not publish packages.
62
46
63
-
- Detects pending changesets
64
-
- Opens a release PR
65
-
- Applies semantic version bumps
66
-
- Generates changelogs
67
-
- Publishes packages to npm
47
+
## Production deployment
68
48
69
-
This keeps releases predictable, traceable, and professional.
49
+
Cloudflare, not GitHub Pages, hosts `magic2u.org`. A successful push to `main` starts a Cloudflare Workers Build using the repository's Wrangler configuration.
70
50
71
51
---
72
52
@@ -76,8 +56,8 @@ This keeps releases predictable, traceable, and professional.
Magic2U turns approved brand decisions into accessible, portable design tokens and production outputs. The public Studio is the fast entry point; the same configuration feeds a deeper architecture for engineering, mobile, print, merchandise, and campaign work.
0 commit comments