Previews of merge requests
Every merge request with a web page or API gets a running preview on your team's runner. kanman tests it against the story's criteria and posts the result in the merge request.
Reading a diff tells you what changed. Clicking through it tells you whether it works. For every merge request on a team repository with a web page or an API, I build and start a preview on your team’s runner, so reviewers can click through the change before it merges.
Where you find it
- In the merge request and on the story: the preview’s link, with the result of my checks.
- In the team’s Apps tab, under the previews of open merge requests.
A preview opens beside the chat, like any app. Full size gives it the whole window; Back beside the chat returns. Reload preview reloads it after a new push.
What I check on a preview
Before I post the result, I test the running preview:
| Check | What it means |
|---|---|
| Start page | The app starts and answers. |
| Page | Each page the change touches loads without errors. |
| API call | The API answers the calls the change touches. |
| Criterion | Each acceptance criterion of the story, tried against the running app. |
| Accessibility | The changed pages pass an accessibility check. |
The result reads “All 12 checks passed” or names the checks that failed. A check that already fails on the target branch is counted separately (“1 more already fails on the target branch, not because of this change”), so nobody chases a problem the merge request did not cause. The reviewer gets the preview link too and can reproduce a finding against it. See How kanman checks its work.
Safe by default
- Only members of the team open its previews.
- Previews use your team’s environment without production secrets.
- A preview stops when the merge request closes, or after a while nobody opened it. I start it again when the merge request changes.
When there is no preview
| You see | Why |
|---|---|
| kanman is building and starting this preview | It appears as soon as it answers. |
| This repository has no web page or API to preview | Nothing to start; the merge request is checked as usual. |
| This preview has stopped | The merge request closed or nobody opened it for a while. |
| The runner that holds this preview offers no address to browsers yet | My checks ran and their result is shown. IT can set up how browsers reach your runners: Let people reach apps directly. |
Previews need a team runner. Without one, the Apps tab says so, and a workspace owner or admin can add one.
Related
Last updated: January 1, 0001
Open kanman