You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove npm script and update demo docs to use renovate CLI directly
- Remove renovate:jest npm script from package.json
- Update demo documentation to be more general about renovate CLI usage
- Include example command with GitHub token setup
- Make documentation less specific to Jest, more broadly applicable
- Renovate CLI installed (included in the devcontainer)
9
+
- Renovate CLI is pre-installed in the devcontainer
10
10
11
11
## Steps to Replicate
12
12
13
13
### 1. Create a Renovate Pull Request
14
14
15
-
Navigate to the catalog service directory and run the renovate Jest command:
15
+
The Renovate CLI is available in this environment and can be used to scan for dependency updates. The repository includes a `renovate.json` configuration that focuses on Jest dependencies.
16
+
17
+
To create a pull request for dependency updates, you can run:
- Create a pull request specifically for Jest dependency updates
26
-
- Target Jest upgrades that may introduce breaking changes
29
+
- Scan for dependency updates (currently configured for Jest)
30
+
- Create pull requests for available updates
31
+
- Target upgrades that may introduce breaking changes
27
32
28
33
### 2. Review the Pull Request
29
34
30
-
After the command completes, check the GitHub repository for the newly created pull request. The PR will contain:
31
-
32
-
-Updated Jest dependencies
33
-
-Breaking changes that need to be addressed
35
+
After the command completes, check the GitHub repository for newly created pull requests. The PRs will contain:
36
+
- Updated dependencies
37
+
-Changelog information about breaking changes
38
+
-Details about what needs to be addressed
34
39
35
40
### 3. Resolve Breaking Changes with AI
36
41
37
42
You have several options to get AI assistance for resolving the breaking changes:
38
43
39
44
#### Option A: Using GitHub CLI
40
-
41
45
```bash
42
46
# Get PR details and diff
43
47
gh pr view <PR_NUMBER> --json body,title,files
@@ -47,23 +51,44 @@ gh pr diff <PR_NUMBER>
47
51
```
48
52
49
53
#### Option B: Manual Context Gathering
50
-
51
54
1. Copy the PR description and diff manually
52
55
2. Include relevant test files that might be affected
53
-
3. Construct a prompt asking for help with Jest migration
56
+
3. Construct a prompt asking for help with dependency migration
54
57
55
58
#### Option C: Direct File Analysis
56
-
57
59
1. Review the failing tests after merging the PR
58
60
2. Copy error messages and affected code
59
-
3. Ask AI to help fix the deprecated Jest matchers
61
+
3. Ask AI to help fix compatibility issues
60
62
61
63
## Example AI Prompt
62
64
63
65
```
64
-
I have a Jest upgrade from v29 to v30 that's causing test failures due to deprecated matchers. Here are the failing tests:
66
+
I have a dependency upgrade that's causing test failures due to breaking changes. Here are the failing tests and error messages:
65
67
66
68
[Include test file contents and error messages]
67
69
68
-
Please help me update the deprecated Jest matchers to their v30 equivalents.
70
+
Please help me update the code to be compatible with the new version.
69
71
```
72
+
73
+
## Renovate Configuration
74
+
75
+
The repository includes a `renovate.json` file that can be customized to target specific dependencies or change update behavior. You can modify this configuration to:
76
+
- Target different packages
77
+
- Change update frequency
78
+
- Adjust PR creation settings
79
+
- Enable/disable specific dependency types
80
+
81
+
## Expected Outcomes
82
+
83
+
- Pull requests with dependency updates
84
+
- Understanding of how to use AI to resolve breaking changes
85
+
- Updated code compatible with new dependency versions
86
+
- Successful test suite execution after fixes
87
+
88
+
## Notes for Sales Engineers
89
+
90
+
- This demonstrates real-world dependency management scenarios
91
+
- Shows how AI can assist with breaking changes during upgrades
92
+
- Highlights the importance of having good test coverage
93
+
- Illustrates the collaborative workflow between automated tools and AI assistance
94
+
- Renovate CLI provides flexibility for different scanning and update strategies
0 commit comments