Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/argos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ jobs:
cd packages/twake-mui
npm run screenshots
env:
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
2 changes: 2 additions & 0 deletions .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ jobs:
run: npm run build --workspace=@linagora/twake-css --workspace=@linagora/twake-icons
- name: Lint
run: npm run lint
- name: Check formatting
run: npm run lint:fmt
- name: Check barrel export
run: npm run check:barrel --workspace=@linagora/twake-icons
- name: Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
uses: actions/deploy-pages@v5
11 changes: 7 additions & 4 deletions .releaserc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@
"@semantic-release/release-notes-generator",
["@semantic-release/changelog", { "changelogFile": "CHANGELOG.md" }],
"@semantic-release/npm",
["@semantic-release/git", {
"assets": ["CHANGELOG.md", "package.json"],
"message": "chore(release): bump package versions"
}],
[
"@semantic-release/git",
{
"assets": ["CHANGELOG.md", "package.json"],
"message": "chore(release): bump package versions"
}
],
"@semantic-release/github"
]
}
9 changes: 7 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ npm run build
npm run lint

# Lint specific package
npm run lint --workspace=twake-mui
npx rs lint packages/twake-mui/src

# Format all files
npm run fmt

# Test dry-run release (safe, no publish)
npm run release:dry
Expand Down Expand Up @@ -114,6 +117,7 @@ npm run screenshots
```

Stories are located in:

- `packages/twake-mui/src/components/**/*.stories.tsx` - Component stories (e.g., Avatar)
- `packages/twake-mui/src/stories/*.stories.tsx` - Override showcase stories

Expand All @@ -133,13 +137,14 @@ export const MyStory = {
## CI/CD Notes

- **Runs on**: PRs and push to main
- **Order**: install → lint → build → release (main only)
- **Order**: install → lint → format check → build → release (main only)
- **Secrets required**: `NODE_AUTH_TOKEN` (NPM token, set in GitHub repo settings)
- **Uses**: `secrets.GITHUB_TOKEN` (auto-provided, no setup needed)

## Commits

Use [Conventional Commits](https://www.conventionalcommits.org/) for automatic versioning:

- `feat:` → minor version bump
- `fix:` → patch version bump
- `feat!:` or `BREAKING CHANGE:` → major version bump
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ twake-ui/

## Packages

| Package | Scope |
| --- | --- |
| `@linagora/twake-css` | The palette (`palette.json`), its `--twake-*` CSS variables (`dist/vars.css`) and the `.u-*` utility classes (`dist/utils.css`). No JavaScript, usable from any stack. |
| `@linagora/twake-icons` | SVG icons and illustrations as React components. |
| `@linagora/twake-mui` | The MUI theme and components. Builds its theme from twake-css's `palette.json`, emits the same `--twake-*` variables at runtime, and renders twake-icons. |
| Package | Scope |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `@linagora/twake-css` | The palette (`palette.json`), its `--twake-*` CSS variables (`dist/vars.css`) and the `.u-*` utility classes (`dist/utils.css`). No JavaScript, usable from any stack. |
| `@linagora/twake-icons` | SVG icons and illustrations as React components. |
| `@linagora/twake-mui` | The MUI theme and components. Builds its theme from twake-css's `palette.json`, emits the same `--twake-*` variables at runtime, and renders twake-icons. |

## Development

Expand Down Expand Up @@ -48,6 +48,14 @@ npm run test
npm run lint
```

[Rslint](https://rslint.rs) lints the code and `rs fmt` formats it, both from [Rstack](https://rstack.rs).

### Format all files

```bash
npm run fmt
```

## Workspace Management

This monorepo uses npm workspaces to manage packages.
Expand Down Expand Up @@ -115,11 +123,7 @@ Create your package in `packages/<name>/` with the required `package.json` field
"publishConfig": {
"access": "public"
},
"files": [
"dist",
"CHANGELOG.md",
"README.md"
]
"files": ["dist", "CHANGELOG.md", "README.md"]
}
```

Expand Down
Loading
Loading