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
Copy file name to clipboardExpand all lines: codegen-examples/examples/github_checks/README.md
+19-15Lines changed: 19 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Github Checks
2
2
3
-
This application is a GitHub integration that analyzes import cycles in Python codebases. It automatically runs when a pull request is labeled and checks for potentially problematic import patterns in the modified codebase.
3
+
This application is a GitHub integration that analyzes import cycles in codebases. It automatically runs when a pull request is labeled and checks for potentially problematic import patterns in the modified codebase.
4
4
5
5
## Features
6
6
7
-
- Analyzes import relationships in Python codebases
7
+
- Analyzes import relationships in codebases
8
8
- Detects circular import dependencies
9
9
- Identifies problematic cycles with mixed static and dynamic imports
10
10
- Automatically comments on pull requests with detailed analysis
@@ -48,19 +48,20 @@ This application is a GitHub integration that analyzes import cycles in Python c
48
48
1. Results are posted as a comment on the pull request
@@ -75,14 +76,17 @@ This application is a GitHub integration that analyzes import cycles in Python c
75
76
76
77
1. Set up your environment variables in a `.env` file
77
78
78
-
-`GITHUB_TOKEN`: Your GitHub token, configured with `repo` and `workflow` scopes
79
+
-`GITHUB_TOKEN`: Your GitHub token, configured with `repo` and `workflow` scopes.
79
80
80
81
1. Deploy the app using Modal:
81
82
82
83
```bash
83
84
modal deploy app.py
84
85
```
85
86
87
+
- After deployment, configure your GitHub App's webhook URL in its developer settings to point to your Modal endpoint with the endpoint `/github/events`
88
+
- The app will analyze imports via the Modal deployment whenever a pull request receives a `Codegen` label
89
+
86
90
## Technical Details
87
91
88
92
The application uses Codegen to parse the codebase and a combination of NetworkX and Codegen to analyze the import relationships. The app is structured as a Modal App with a FastAPI server.
0 commit comments