@bcc-code/design-tokens 3.0.18 → 3.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -83
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -139,91 +139,9 @@ document.documentElement.classList.toggle('dark')
|
|
|
139
139
|
</script>
|
|
140
140
|
```
|
|
141
141
|
|
|
142
|
-
## Development
|
|
143
|
-
|
|
144
|
-
```bash
|
|
145
|
-
git clone https://github.com/bcc-code/bcc-tokens.git
|
|
146
|
-
cd bcc-tokens
|
|
147
|
-
npm install
|
|
148
|
-
npm run build
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
Run demo:
|
|
152
|
-
|
|
153
|
-
```bash
|
|
154
|
-
cd demo
|
|
155
|
-
npm install
|
|
156
|
-
npm run dev
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
Visit `http://localhost:5173`
|
|
160
|
-
|
|
161
|
-
## Project Structure
|
|
162
|
-
|
|
163
|
-
```
|
|
164
|
-
tokens/ # Source tokens (Figma Token Studio)
|
|
165
|
-
export-tokens/ # Build system
|
|
166
|
-
config/ # PrimeVue preset
|
|
167
|
-
build/bcc/ # Generated output
|
|
168
|
-
demo/ # Demo application
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
## Publishing
|
|
172
|
-
|
|
173
|
-
Releases are managed through GitHub Actions with automated validation and publishing.
|
|
174
|
-
|
|
175
|
-
### For Maintainers
|
|
176
|
-
|
|
177
|
-
1. **Make your changes** to tokens or config files
|
|
178
|
-
```bash
|
|
179
|
-
git add .
|
|
180
|
-
git commit -m "Update design tokens"
|
|
181
|
-
git push origin design # or main
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
2. **Go to GitHub Actions**
|
|
185
|
-
- Navigate to the [Actions tab](../../actions/workflows/release.yml)
|
|
186
|
-
- Click on **"Release and Publish"**
|
|
187
|
-
- Click **"Run workflow"** button
|
|
188
|
-
|
|
189
|
-
3. **Configure release**
|
|
190
|
-
- **Branch**: Select your branch (usually `design` or `main`)
|
|
191
|
-
- **Version bump**:
|
|
192
|
-
- `patch` - Bug fixes, small changes (3.0.17 → 3.0.18)
|
|
193
|
-
- `minor` - New features, new tokens (3.0.17 → 3.1.0)
|
|
194
|
-
- `major` - Breaking changes (3.0.17 → 4.0.0)
|
|
195
|
-
- **Dry run**: Enable to test without publishing
|
|
196
|
-
|
|
197
|
-
4. **Run the workflow**
|
|
198
|
-
- Click **"Run workflow"**
|
|
199
|
-
- Wait 2-3 minutes for completion
|
|
200
|
-
- Package is published to NPM with `latest` tag
|
|
201
|
-
|
|
202
|
-
### What Happens Automatically
|
|
203
|
-
|
|
204
|
-
The workflow performs these steps:
|
|
205
|
-
- ✅ Validates all dependencies
|
|
206
|
-
- ✅ Bumps version in package.json
|
|
207
|
-
- ✅ Builds tokens and verifies output
|
|
208
|
-
- ✅ Checks version doesn't exist on NPM
|
|
209
|
-
- ✅ Runs dry-run publish test
|
|
210
|
-
- ✅ Creates git commit and tag
|
|
211
|
-
- ✅ Creates GitHub Release with changelog
|
|
212
|
-
- ✅ Publishes to NPM
|
|
213
|
-
- ✅ Verifies package is live
|
|
214
|
-
- 🔄 Rolls back on any failure
|
|
215
|
-
|
|
216
|
-
### Testing Before Publishing
|
|
217
|
-
|
|
218
|
-
Enable **"Run in dry-run mode"** to test the entire process without actually publishing to NPM.
|
|
219
|
-
|
|
220
|
-
### For Complete Documentation
|
|
221
|
-
|
|
222
|
-
See [.github/workflows/README.md](.github/workflows/README.md) for detailed instructions, troubleshooting, and FAQ.
|
|
223
|
-
|
|
224
142
|
## Contributing
|
|
225
143
|
|
|
226
|
-
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
144
|
+
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, workflow, and publishing instructions.
|
|
227
145
|
|
|
228
146
|
## License
|
|
229
147
|
|