Skip to main content

Integration guideSeal API and Scripts

GitLab

Link commits, merge requests and issues to Seal records.

Illustration of a seal beside a laptop showing a data table and an evidence binder linked by a red thread.

GitLab to SealSeal API and Scripts

Seal reads
Merge requests, commits, issues and pipeline results
Writes back
If agreed
Source of truth
Agreed when scoped
Set up
Scoped with your team
Neil › Software change review
draft

Connect the code change to its review and test evidence.

Neil

  • Once the connection is configured, I’ll use the records it provides and cite each one. Anything it doesn’t supply stays listed as missing.
Reads
Merge requests, commits, issues and pipeline results
Returns
  • Change references and verification evidence
  • Missing or unmatched information
  • Next steps for your team to review
Illustrative work with GitLab: a request to Neil, the source it reads and the draft it returns for your review.

1What’s connected.

Link GitLab merge requests, commits, issues and pipeline results to Seal change records through a connection set up with Seal’s API or Scripts. Agree which projects, branches and review evidence each change record needs.

Connection setup and permissions

Use Seal’s APIs or scripting engine for a connection tailored to your process. Agree the data mapping, access and direction of transfer before implementation.

Related blueprints

2Link GitLab merge requests and pipelines to Seal change records.

Route

Merge request webhooks fire on open, update, approval, unapproval, merge and close, and when a commit is pushed to the source branch. Pipeline events fire when a pipeline’s status changes.⁠¹ The commit status API sets a named status on a commit; for a merge request, it goes on the source branch’s commit.⁠² The pipelines API and the merge request approval API are available on every tier, Free included.⁠³⁴

Merge rules

With Pipelines must succeed set, a merge request with no pipeline cannot merge, and this works for pipelines from an external CI integration too.⁠⁵ External status checks are an Ultimate feature. By default a merge request can merge even if they fail, unless the project blocks it.⁠⁶

Revisions

An update event with code changes, such as a push to the source branch, carries oldrev.⁠¹ An approval or a status check response must name the merge request’s current HEAD, or GitLab answers 409 Conflict.⁠⁴⁶

When it fails

An event arrives with nothing changed
Merge request events can arrive with an empty changes field.⁠¹ Read the merge request itself before updating the Seal record.
An approval is refused with 409
The approval’s SHA no longer matches the merge request’s HEAD.⁠⁴ Fetch the current HEAD, check the change record against it and approve again.
An external status check failed on its own
A status check fails if it stays pending for more than two minutes.⁠⁶ Answer within two minutes, or run the check again.

Check one record

Open a merge request on a test project and push a second commit. The Seal record should show the new HEAD. An approval sent with the old SHA should be refused with 409, and one sent with the new SHA accepted.

3Start with the job.

Tell us what Neil needs to do and which records it needs. We’ll confirm the interface, permissions and implementation scope with your team.

Discuss this connection →

4Before it goes live.

Access and any write-back

Define which records are in scope and whose permissions apply. Whether the connection writes back at all is a separate decision, with its own mapping and approval.

Verification and release

Review the configured connection for its intended use. Keep the requirements, checks and evidence with the change, and approve the release through your team’s controls.

Read the assurance detail →

References

  1. 1GitLab: webhook events.
  2. 2GitLab API: commits.
  3. 3GitLab API: pipelines.
  4. 4GitLab API: merge request approvals.
  5. 5GitLab: auto-merge.
  6. 6GitLab: external status checks.