Skip to content

Commit 0cebb81

Browse files
Correct workflow documentation and add build status
1 parent 46f5857 commit 0cebb81

2 files changed

Lines changed: 22 additions & 42 deletions

File tree

.github/workflows/README.md

Lines changed: 20 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# ⚙️ Magic2U Monorepo — CI, Accessibility, Deployment & Release Workflows
1+
# Magic2U automation
22

3-
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.
44

55
This document explains each workflow and how it fits into the Magic2U ecosystem.
66

77
---
88

9-
# 🧪 1. Continuous Integration (CI)
9+
## 1. Continuous Integration
1010

1111
**File:** `.github/workflows/ci.yml`
1212
**Purpose:** Validate code quality on every push and pull request.
1313

14-
CI typically includes:
14+
The active workflow includes:
1515

1616
- TypeScript type checking
1717
- Linting
1818
- Unit tests
1919
- Build verification
2020

21-
This ensures that no broken code enters the main branch.
21+
This is the required product-health check on `main`.
2222

2323
---
2424

25-
# 2. Accessibility Check
25+
## 2. Accessibility check
2626

2727
**File:** `.github/workflows/accessibility-check.yml`
2828
**Purpose:** Prevent accessibility regressions before merging.
@@ -37,36 +37,16 @@ This keeps the design system inclusive and compliant.
3737

3838
---
3939

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
5741

5842
**File:** `.github/workflows/release.yml`
59-
**Purpose:** Automate versioning and publishing of Magic2U packages.
43+
**Purpose:** Manually validate a release candidate before publication.
6044

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.
6246

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
6848

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.
7050

7151
---
7252

@@ -76,8 +56,8 @@ This keeps releases predictable, traceable, and professional.
7656
|---------|---------|---------|
7757
| **CI** | Build, lint, test, type-check | Push & PR |
7858
| **Accessibility Check** | Run a11y test suite | PR |
79-
| **Deploy Pages** | Publish docs/Storybook | Push to `main` |
80-
| **Release** | Version & publish packages | Merge of release PR |
59+
| **Cloudflare Workers Build** | Build and deploy `magic2u.org` | Push to `main` |
60+
| **Release Readiness** | Validate a release candidate | Manual |
8161

8262
---
8363

@@ -90,14 +70,12 @@ Magic2U’s automation pipeline follows a clear flow:
9070
- Accessibility checks run
9171
- Preview deployments run (optional)
9272

93-
2. **PR is reviewed and merged**
94-
- Deploy Pages publishes updated docs
95-
- Release workflow prepares version bumps
73+
2. **PR is reviewed and merged**
74+
- Continuous Integration runs on `main`
75+
- Cloudflare builds and deploys production
9676

97-
3. **Release PR is merged**
98-
- Packages are published to npm
99-
- Changelogs are generated
100-
- GitHub releases are created
77+
3. **A release candidate needs validation**
78+
- A maintainer manually runs Release Readiness
10179

10280
This creates a smooth, professional, end‑to‑end development experience.
10381

@@ -109,7 +87,7 @@ Magic2U’s GitHub Actions workflows ensure:
10987

11088
- High code quality
11189
- Strong accessibility guarantees
112-
- Automatic documentation deployment
113-
- Predictable, automated releases
90+
- Cloudflare production deployment
91+
- Repeatable manual release validation
11492

11593
These workflows form the backbone of a scalable, contributor‑friendly engineering system.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Magic2U Design-System Platform
22

3+
[![Continuous Integration](https://github.com/healthearthack/magic2u.org/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/healthearthack/magic2u.org/actions/workflows/ci.yml)
4+
35
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.
46

57
Production: [magic2u.org](https://magic2u.org)

0 commit comments

Comments
 (0)