guideai-app 0.4.2-2 → 0.4.3
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/.workflow-test +1 -0
- package/PRODUCTION_RELEASE.md +126 -0
- package/dist/GuideAI.js +1 -1
- package/dist/GuideAI.js.map +1 -1
- package/dist/metric/event-listner.d.ts +143 -0
- package/dist/styles/GuideAI.styles.d.ts +1 -1
- package/dist/utils/constants.d.ts +1 -0
- package/dist/utils/elementInteractions.d.ts +1 -2
- package/dist/utils/gemini.d.ts +3 -1
- package/dist/utils/highlightAndClick.d.ts +3 -0
- package/dist/utils/hoverAndClick.d.ts +4 -0
- package/package.json +9 -1
package/.workflow-test
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Workflow Test
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# Production Release Guide - guideai-app npm Package
|
|
2
|
+
|
|
3
|
+
This guide covers how to publish production releases of `guideai-app` to the public npm registry.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
- [ ] Changes merged and tested on `development` branch
|
|
8
|
+
- [ ] Ready to create a production release
|
|
9
|
+
- [ ] npm account with publish access to `guideai-app`
|
|
10
|
+
|
|
11
|
+
## Release Process
|
|
12
|
+
|
|
13
|
+
### 1. Merge Development to Production
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
git checkout production
|
|
17
|
+
git pull origin production
|
|
18
|
+
git merge development
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Resolve any conflicts if needed.
|
|
22
|
+
|
|
23
|
+
### 2. Update Version Number
|
|
24
|
+
|
|
25
|
+
**Option A: Use npm version command (Recommended)**
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
cd guide-ai-package
|
|
29
|
+
npm version patch # 0.4.2 → 0.4.3
|
|
30
|
+
# or
|
|
31
|
+
npm version minor # 0.4.2 → 0.5.0
|
|
32
|
+
# or
|
|
33
|
+
npm version major # 0.4.2 → 1.0.0
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This automatically:
|
|
37
|
+
- Updates package.json
|
|
38
|
+
- Creates a git commit
|
|
39
|
+
- Creates a git tag
|
|
40
|
+
|
|
41
|
+
Then push:
|
|
42
|
+
```bash
|
|
43
|
+
git push origin production --follow-tags
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
**Option B: Manual update**
|
|
47
|
+
|
|
48
|
+
If you prefer manual control:
|
|
49
|
+
|
|
50
|
+
1. Edit `guide-ai-package/package.json`:
|
|
51
|
+
```json
|
|
52
|
+
{
|
|
53
|
+
"name": "guideai-app",
|
|
54
|
+
"version": "0.4.3", // ← Increment this
|
|
55
|
+
...
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
2. Commit:
|
|
60
|
+
```bash
|
|
61
|
+
git add guide-ai-package/package.json
|
|
62
|
+
git commit -m "chore: bump version to 0.4.3"
|
|
63
|
+
git push origin production
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### 4. Build the Package
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
cd guide-ai-package
|
|
70
|
+
npm run build
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Verify build completes successfully.
|
|
74
|
+
|
|
75
|
+
### 5. Publish to npm Registry
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
npm publish --registry https://registry.npmjs.org/
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
**Important:** The `--registry` flag ensures publication to npm, not GitHub Packages.
|
|
82
|
+
|
|
83
|
+
### 6. Verify Publication
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
npm view guideai-app
|
|
87
|
+
|
|
88
|
+
# Should show your new version as 'latest'
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### 7. Tag the Release (Optional but Recommended)
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
git tag -a v0.4.3 -m "Release v0.4.3"
|
|
95
|
+
git push origin v0.4.3
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## After Release
|
|
99
|
+
|
|
100
|
+
- [ ] New version available at https://www.npmjs.com/package/guideai-app
|
|
101
|
+
- [ ] Customers can install with `npm install guideai-app@0.4.3`
|
|
102
|
+
- [ ] Update guideaisite production environment to use new version
|
|
103
|
+
|
|
104
|
+
## Notes
|
|
105
|
+
|
|
106
|
+
- **Dev releases** (beta tags) are automated via GitHub Actions → GitHub Packages
|
|
107
|
+
- **Production releases** are manual via this process → npm registry
|
|
108
|
+
- This ensures production releases are intentional and controlled
|
|
109
|
+
- The scoped package `@guideai/guideai-app` on GitHub Packages is separate and unaffected
|
|
110
|
+
|
|
111
|
+
## Troubleshooting
|
|
112
|
+
|
|
113
|
+
**Error: "You must be logged in to publish packages"**
|
|
114
|
+
```bash
|
|
115
|
+
npm login
|
|
116
|
+
# Follow prompts to authenticate
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
**Error: "You do not have permission to publish"**
|
|
120
|
+
- Verify your npm account has publish access to `guideai-app`
|
|
121
|
+
- Contact package maintainer to add you
|
|
122
|
+
|
|
123
|
+
**Wrong package published:**
|
|
124
|
+
- You can unpublish within 72 hours: `npm unpublish guideai-app@VERSION`
|
|
125
|
+
- After 72 hours, must deprecate: `npm deprecate guideai-app@VERSION "reason"`
|
|
126
|
+
|