@odigos/ui-kit 0.0.111 → 0.0.112
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/.devcontainer/devcontainer.json +3 -1
- package/CHANGELOG.md +7 -0
- package/VERSIONING.md +228 -0
- package/lib/chunks/{ui-components-152ce1ee.js → ui-components-ff58030e.js} +32 -31
- package/lib/components/input-table/index.d.ts +1 -0
- package/lib/components.js +1 -1
- package/lib/constants/strings/index.d.ts +2 -2
- package/lib/constants.js +1 -1
- package/lib/containers.js +48 -48
- package/lib/functions.js +1 -1
- package/lib/hooks.js +1 -1
- package/lib/icons.js +1 -1
- package/lib/snippets.js +1 -1
- package/lib/store.js +1 -1
- package/lib/theme.js +1 -1
- package/lib/types/instrumentation-rules/index.d.ts +11 -4
- package/lib/types.js +1 -1
- package/package.json +1 -1
|
@@ -5,7 +5,9 @@
|
|
|
5
5
|
"vscode": {
|
|
6
6
|
"extensions": [
|
|
7
7
|
"ms-vscode.vscode-eslint",
|
|
8
|
-
"styled-components.vscode-styled-components"
|
|
8
|
+
"styled-components.vscode-styled-components",
|
|
9
|
+
"eamodio.gitlens",
|
|
10
|
+
"foxundermoon.shell-format"
|
|
9
11
|
],
|
|
10
12
|
"settings": {
|
|
11
13
|
"editor.formatOnSave": true,
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.112](https://github.com/odigos-io/ui-kit/compare/ui-kit-v0.0.111...ui-kit-v0.0.112) (2025-10-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* RUN-150 | custom probes | further changes for types ([#425](https://github.com/odigos-io/ui-kit/issues/425)) ([b865ad2](https://github.com/odigos-io/ui-kit/commit/b865ad27a03a8f428f478b2f661185d3d5ac5741))
|
|
9
|
+
|
|
3
10
|
## [0.0.111](https://github.com/odigos-io/ui-kit/compare/ui-kit-v0.0.110...ui-kit-v0.0.111) (2025-10-19)
|
|
4
11
|
|
|
5
12
|
|
package/VERSIONING.md
ADDED
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# Versioning Guide
|
|
2
|
+
|
|
3
|
+
This document explains how versioning and releases work for the `@odigos/ui-kit` package.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
The UI Kit uses a dual-release strategy:
|
|
8
|
+
|
|
9
|
+
- **Main releases**: Stable versions published to the `latest` npm tag
|
|
10
|
+
- **Dev releases**: Prerelease versions published to the `dev` npm tag
|
|
11
|
+
|
|
12
|
+
## Release Types
|
|
13
|
+
|
|
14
|
+
### 1. Main Releases (Stable)
|
|
15
|
+
|
|
16
|
+
**Trigger**: Push/merge to `main` branch
|
|
17
|
+
**Workflow**: `.github/workflows/npm-publish.yml`
|
|
18
|
+
**NPM Tag**: `latest` (default)
|
|
19
|
+
**Version Format**: `MAJOR.MINOR.PATCH` (e.g., `1.8.0`)
|
|
20
|
+
|
|
21
|
+
#### How it works:
|
|
22
|
+
|
|
23
|
+
1. **Release Please**: Automatically manages versioning using conventional commits
|
|
24
|
+
2. **Version Bumping**:
|
|
25
|
+
- `feat:` commits → minor version bump
|
|
26
|
+
- `fix:` commits → patch version bump
|
|
27
|
+
- `BREAKING CHANGE:` → major version bump
|
|
28
|
+
3. **Release Process**:
|
|
29
|
+
- Creates a release PR with updated version and changelog
|
|
30
|
+
- After PR merge, automatically publishes to npm with `latest` tag
|
|
31
|
+
|
|
32
|
+
#### Installation:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm install @odigos/ui-kit
|
|
36
|
+
# or
|
|
37
|
+
npm install @odigos/ui-kit@latest
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### 2. Dev Releases (Prerelease)
|
|
41
|
+
|
|
42
|
+
**Trigger**: Push to `dev` branch
|
|
43
|
+
**Workflow**: `.github/workflows/publish-dev.yml`
|
|
44
|
+
**NPM Tag**: `dev`
|
|
45
|
+
**Version Format**: `MAJOR.MINOR.PATCH-dev.COMMIT_COUNT` (e.g., `1.8.0-dev.15`)
|
|
46
|
+
|
|
47
|
+
#### How it works:
|
|
48
|
+
|
|
49
|
+
1. **Automatic Triggering**: Runs on every push to the `dev` branch
|
|
50
|
+
2. **Version Generation**:
|
|
51
|
+
- Takes current version from `package.json`
|
|
52
|
+
- Appends `-dev.{commit-count}` suffix
|
|
53
|
+
- Example: `0.0.110` → `0.0.110-dev.15`
|
|
54
|
+
3. **Publishing**: Automatically publishes to npm with `dev` tag
|
|
55
|
+
|
|
56
|
+
#### Installation:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npm install @odigos/ui-kit@dev
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Version Numbering
|
|
63
|
+
|
|
64
|
+
### Current Version
|
|
65
|
+
|
|
66
|
+
- **Current**: `0.0.110` (as of latest release)
|
|
67
|
+
- **Format**: `MAJOR.MINOR.PATCH`
|
|
68
|
+
- **Pre-major**: Currently in pre-major phase (0.x.x)
|
|
69
|
+
|
|
70
|
+
### Version Bumping Rules
|
|
71
|
+
|
|
72
|
+
#### Main Releases (via Release Please)
|
|
73
|
+
|
|
74
|
+
- **Major** (`1.0.0`): Breaking changes (requires `BREAKING CHANGE:` in commit)
|
|
75
|
+
- **Minor** (`0.1.0`): New features (requires `feat:` prefix)
|
|
76
|
+
- **Patch** (`0.0.1`): Bug fixes (requires `fix:` prefix)
|
|
77
|
+
|
|
78
|
+
#### Dev Releases
|
|
79
|
+
|
|
80
|
+
- **Base Version**: Inherits from current `package.json` version
|
|
81
|
+
- **Prerelease Suffix**: `-dev.{commit-count}`
|
|
82
|
+
- **Incremental**: Each push to dev branch creates a new prerelease
|
|
83
|
+
|
|
84
|
+
## Workflow Examples
|
|
85
|
+
|
|
86
|
+
### Main Release Workflow
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# 1. Make changes with conventional commits
|
|
90
|
+
git commit -m "feat: add new button component"
|
|
91
|
+
git commit -m "fix: resolve styling issue in modal"
|
|
92
|
+
|
|
93
|
+
# 2. Push to main
|
|
94
|
+
git push origin main
|
|
95
|
+
|
|
96
|
+
# 3. Release Please creates PR automatically
|
|
97
|
+
# 4. Merge PR → triggers npm publish to 'latest' tag
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Dev Release Workflow
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# 1. Switch to dev branch
|
|
104
|
+
git checkout dev
|
|
105
|
+
|
|
106
|
+
# 2. Make experimental changes
|
|
107
|
+
git commit -m "wip: experimental feature"
|
|
108
|
+
git push origin dev
|
|
109
|
+
|
|
110
|
+
# 3. Automatically publishes to npm with 'dev' tag
|
|
111
|
+
# Version: 0.0.110-dev.16 (example)
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Installation Commands
|
|
115
|
+
|
|
116
|
+
### Stable Release (Recommended for Production)
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
npm install @odigos/ui-kit
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Latest Dev Release (For Testing)
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
npm install @odigos/ui-kit@dev
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Specific Version
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
npm install @odigos/ui-kit@0.0.110
|
|
132
|
+
npm install @odigos/ui-kit@0.0.110-dev.15
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Branch Strategy
|
|
136
|
+
|
|
137
|
+
### `main` Branch
|
|
138
|
+
|
|
139
|
+
- **Purpose**: Stable, production-ready code
|
|
140
|
+
- **Releases**: Full releases with `latest` tag
|
|
141
|
+
- **Versioning**: Managed by Release Please
|
|
142
|
+
- **Usage**: Production applications
|
|
143
|
+
|
|
144
|
+
### `dev` Branch
|
|
145
|
+
|
|
146
|
+
- **Purpose**: Development and experimental features
|
|
147
|
+
- **Releases**: Prerelease versions with `dev` tag
|
|
148
|
+
- **Versioning**: Automatic with commit count
|
|
149
|
+
- **Usage**: Testing and development
|
|
150
|
+
|
|
151
|
+
## Configuration Files
|
|
152
|
+
|
|
153
|
+
### Release Please Configuration
|
|
154
|
+
|
|
155
|
+
- **File**: `release-please-config.json`
|
|
156
|
+
- **Purpose**: Configures automatic versioning for main releases
|
|
157
|
+
- **Settings**:
|
|
158
|
+
- `bump-minor-pre-major: true` - Minor bumps during pre-major phase
|
|
159
|
+
- `bump-patch-for-minor-pre-major: true` - Patch bumps for minor changes
|
|
160
|
+
- `release-type: "node"` - Node.js package release type
|
|
161
|
+
|
|
162
|
+
### Package.json
|
|
163
|
+
|
|
164
|
+
- **Version**: Current version (e.g., `0.0.110`)
|
|
165
|
+
- **Release Branches**: `["main"]` - Only main branch creates releases
|
|
166
|
+
- **Publish Config**: `"access": "public"` - Public npm package
|
|
167
|
+
|
|
168
|
+
## Best Practices
|
|
169
|
+
|
|
170
|
+
### For Main Releases
|
|
171
|
+
|
|
172
|
+
1. **Use Conventional Commits**: Follow `feat:`, `fix:`, `BREAKING CHANGE:` format
|
|
173
|
+
2. **Review Release PRs**: Check generated changelog and version
|
|
174
|
+
3. **Test Before Merge**: Ensure all changes work correctly
|
|
175
|
+
4. **Merge Release PRs**: Don't edit them manually
|
|
176
|
+
|
|
177
|
+
### For Dev Releases
|
|
178
|
+
|
|
179
|
+
1. **Experimental Features**: Use dev branch for testing new features
|
|
180
|
+
2. **Frequent Pushes**: Each push creates a new prerelease
|
|
181
|
+
3. **Clear Commit Messages**: Help track what changed in each dev release
|
|
182
|
+
4. **Test Thoroughly**: Dev releases should be tested before promoting to main
|
|
183
|
+
|
|
184
|
+
### For Consumers
|
|
185
|
+
|
|
186
|
+
1. **Production**: Use `@latest` or no tag (stable releases)
|
|
187
|
+
2. **Development**: Use `@dev` for testing new features
|
|
188
|
+
3. **Specific Versions**: Pin to specific versions for reproducible builds
|
|
189
|
+
4. **Update Strategy**: Regularly update to get latest fixes and features
|
|
190
|
+
|
|
191
|
+
## Troubleshooting
|
|
192
|
+
|
|
193
|
+
### Common Issues
|
|
194
|
+
|
|
195
|
+
#### Dev Release Not Publishing
|
|
196
|
+
|
|
197
|
+
- Check if `NPM_TOKEN` secret is configured in GitHub
|
|
198
|
+
- Verify the workflow is running on dev branch pushes
|
|
199
|
+
- Check GitHub Actions logs for errors
|
|
200
|
+
|
|
201
|
+
#### Version Conflicts
|
|
202
|
+
|
|
203
|
+
- Dev releases use commit count, so conflicts are unlikely
|
|
204
|
+
- Main releases use Release Please, which handles conflicts automatically
|
|
205
|
+
|
|
206
|
+
#### Installation Issues
|
|
207
|
+
|
|
208
|
+
- Use `npm install @odigos/ui-kit@dev` for dev releases
|
|
209
|
+
- Use `npm install @odigos/ui-kit` for stable releases
|
|
210
|
+
- Clear npm cache if needed: `npm cache clean --force`
|
|
211
|
+
|
|
212
|
+
## Release History
|
|
213
|
+
|
|
214
|
+
Current version: `0.0.110`
|
|
215
|
+
|
|
216
|
+
### Recent Releases
|
|
217
|
+
|
|
218
|
+
- Check [GitHub Releases](https://github.com/odigos-io/ui-kit/releases) for full history
|
|
219
|
+
- Dev releases are not tracked in GitHub releases (npm only)
|
|
220
|
+
|
|
221
|
+
## Support
|
|
222
|
+
|
|
223
|
+
For questions about versioning or releases:
|
|
224
|
+
|
|
225
|
+
1. Check this documentation
|
|
226
|
+
2. Review GitHub Actions logs
|
|
227
|
+
3. Check npm package page: https://www.npmjs.com/package/@odigos/ui-kit
|
|
228
|
+
4. Open an issue in the repository
|