Skip to content

Commit 97db879

Browse files
ci(greptile): add review config with application-sdk cross-reference
Add .greptile/ configuration to enable Greptile code reviews with cross-repository awareness of atlanhq/application-sdk as a pattern repository. Includes rules for SDK API alignment, version pinning checks, and test coverage for SDK integration points.
1 parent 791512e commit 97db879

3 files changed

Lines changed: 51 additions & 0 deletions

File tree

β€Ž.greptile/config.jsonβ€Ž

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"strictness": 3,
3+
"commentTypes": ["logic", "syntax", "compatibility"],
4+
"patternRepositories": ["atlanhq/application-sdk"],
5+
"rules": [
6+
{
7+
"id": "sdk-api-alignment",
8+
"rule": "Check if changes to pyatlan align with the application-sdk interfaces. When pyatlan uses SDK base classes (BaseApplication, ClientInterface, HandlerInterface, ActivitiesInterface, WorkflowInterface) or services (ObjectStore, StateStore, SecretStore, EventStore, Reader, Writer), verify usage matches the current SDK API contracts.",
9+
"scope": ["pyatlan/**/*.py"],
10+
"severity": "high"
11+
},
12+
{
13+
"id": "sdk-version-pinning",
14+
"rule": "When atlan-application-sdk version is bumped or dependency constraints change, review the changelog for breaking changes that may affect pyatlan's usage of SDK APIs.",
15+
"scope": ["pyproject.toml", "requirements*.txt", "uv.lock"],
16+
"severity": "high"
17+
},
18+
{
19+
"id": "test-coverage-for-sdk-integration",
20+
"rule": "Changes to code that integrates with application-sdk should include corresponding test updates to catch incompatibilities early.",
21+
"scope": ["pyatlan/**/*.py"],
22+
"severity": "medium"
23+
}
24+
]
25+
}

β€Ž.greptile/files.jsonβ€Ž

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"files": [
3+
{
4+
"path": "pyproject.toml",
5+
"description": "Project dependencies including application-sdk version constraints"
6+
}
7+
]
8+
}

β€Ž.greptile/rules.mdβ€Ž

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## SDK Compatibility
2+
3+
This repository depends on `atlanhq/application-sdk`. When reviewing changes, consider:
4+
5+
- **SDK API usage**: pyatlan uses SDK base classes and services. Any change to how
6+
these are called or extended must match the SDK's current API surface.
7+
- **Version compatibility**: When the SDK dependency version changes, verify that
8+
pyatlan's usage is compatible with the new version's interfaces.
9+
- **Behavioral assumptions**: Changes that rely on specific SDK behavior (e.g.,
10+
ObjectStore path normalization, Dapr service defaults, Temporal workflow semantics)
11+
should be validated against the SDK's documented or tested behavior.
12+
13+
## Key Integration Points
14+
15+
- `pyatlan.client` β€” SDK client wrappers and API interactions
16+
- `pyatlan.model` β€” Data models that may extend or interact with SDK types
17+
- `pyatlan.events` β€” Event handling that integrates with SDK EventStore
18+
- `pyatlan.cache` β€” Caching layer that may use SDK StateStore

0 commit comments

Comments
Β (0)