TKC-6382 docs: add Git Integration user & developer guide - #628
Open
buarki wants to merge 12 commits into
Open
Conversation
Documents the Git Integration feature end-to-end: prerequisites, GitHub App install, repository onboarding, event triggers, .testkube/git-integration.yml config, auto-gen Workflow labels + detach mechanism, PR event parameters, filtering Executions by Git Integration, re-scan behaviour, GitHub check-run mapping, and troubleshooting. Product name lands as Git Integration; the docs reflect the current customer-facing surface (labels, config path, actor.type filter chip). The internal Quality Loop name is intentionally not shown in the docs. Wires the new page into the Integrations section of the sidebar next to the Overview entry. TKC-6382.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
drop the .testkube/git-integration.yml section and the per-PR parent execution mention.
it is scan-or-attach, not both. detection is best-effort and gives a starting point, not a final selection.
covers PR feedback style, merge blocking toggle, and the AI summary block (agent, model, run-when).
covers re-running with @testkube and moving a github actions test job onto a test workflow.
one session per pr, accessible from the pr comment and from the integration events tab; both land on the same chats view.
tkonieczny
reviewed
Aug 19, 2026
| | `PR_BASE_REF` | Base branch of the PR (e.g. `main`). | | ||
| | `PR_HEAD_REF` | Head branch of the PR. | | ||
| | `PR_AUTHOR` | GitHub login of the PR author. | | ||
| | `revision` | Commit SHA of the event, used by content steps to clone at that revision. | |
Contributor
There was a problem hiding this comment.
I think revision should be consistent with other values - PR_REVISION. Without the prefix (PR_) it can collide with existing config values
| 1. Pick the org and repo (only repos the App is installed on show up). | ||
| 2. Choose what runs against it: | ||
| - **Attach existing Workflows** already in this environment, or | ||
| - **Scan the repo** and let Testkube propose a starting point based on the detected stack (Playwright, Cypress, Jest, Go, JMeter, Artillery, and others). Detection is best-effort, review and adjust the proposed set before confirming. |
Contributor
There was a problem hiding this comment.
Is the discovery now extended? For wizard it was just Playwright, Cypress, k6 and Postman
| Framework detection is refreshed in two cases: | ||
|
|
||
| - **Automatic**: when a PR event touches a stack anchor (`package.json`, `go.mod`, `pom.xml`, `requirements.txt`, `playwright.config.ts`, `cypress.config.ts`), Git Integration re-runs detection on the PR head and updates the set of auto-gen Workflows before executing. | ||
| - **Manual**: remove the integration from the dashboard and onboard again. A one-click **Rescan** button is on the roadmap. |
| Each run reports a single aggregate **check-run** on the PR (or a commit status on push/tag/release). Clicking it opens the execution details in Testkube. | ||
|
|
||
| - Any **failed** required Workflow marks the check-run failed. | ||
| - **Cancelled** / **aborted** marks it neutral. |
Contributor
There was a problem hiding this comment.
**aborted** marks it neutral
Something failed and execution never finished (timeout, OOMKilled, whatever) - it should be the same as failed
- correct auto-gen framework list to what the detector actually ships (Playwright, Cypress, k6, Postman, JMeter, Maven, Gradle, Go, Node) - clarify that revision is the git-content-step input, not a PR_* variable - drop the roadmap Rescan claim; describe the real automatic rescan on stack-anchor changes and the disconnect-and-connect workaround - fix results mapping: any not-passed status resolves to failure on the aggregate check-run (there is no neutral conclusion), superseded runs are silently skipped
Michael's consistency ask: connect/disconnect is the mechanic, so strip 'onboarding'-flavored wording from the customer-facing doc when it refers to the act of linking a repo to Testkube. - Prereq: 'user onboarding must have admin' -> 'user connecting the repository must have admin' - Heading and dashboard-path: 'Onboarding a repository' / 'Onboard repository' -> 'Connecting a repository' / 'Connect repository' - 'attached during onboarding' -> 'attached when the repository is connected'.
The feature is now referred to as Advanced Git Integration. Doc title, prose mentions of the feature by name, and the sidebar label switch to the new name. UI navigation quotes (Integrations > Git Integration) and the literal filter-chip name stay as they appear on screen today; those will follow whenever the UI label is updated.
buarki
marked this pull request as ready for review
August 21, 2026 19:12
Contributor
|
Automatic reviews are disabled for this repository. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the customer + developer reference for the Git Integration feature to docs/articles/git-integration.mdx and links it into the Integrations section of the sidebar right after Overview
What the page covers