Support for our SDK and webhooks for CI/CD#142
Closed
John Gluck (JohnGluck) wants to merge 4 commits into
Closed
Conversation
- Created qawolf/rest-overview.mdx - Created qawolf/deploy-success.mdx - Created qawolf/environment_terminated.mdx - Created qawolf/v0-ci-greenlight.mdx - Created qawolf/run-inputs-executables-signed-urls.mdx - Created qawolf/other-ci-node.mdx - Created qawolf/other-ci-webhook.mdx - Updated docs.json Mintlify-Source: dashboard-editor
- Updated qawolf/GitLab-2a15b2a994fb805d9d14ff27726065ae.mdx - Updated qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx - Updated qawolf/other-ci-webhook.mdx - Updated qawolf/other-ci-node.mdx - Updated qawolf/circle-ci.mdx Mintlify-Source: dashboard-editor
- Updated qawolf/other-ci-node.mdx - Updated qawolf/other-ci-webhook.mdx - Updated qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx Mintlify-Source: dashboard-editor
- Updated qawolf/other-ci-node.mdx - Updated qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx Mintlify-Source: dashboard-editor
John Gluck (JohnGluck)
requested review from
Mateus Zitelli (MateusZitelli) and
Eric Dobbertin (aldeed)
and removed request for
Eric Dobbertin (aldeed)
Collaborator
Author
|
This PR goes second, after #143 which will fix the broken links above |
There was a problem hiding this comment.
Pull request overview
Adds new CI/CD integration guides and REST/webhook endpoint reference pages to support SDK- and webhook-based pipelines, and updates site navigation to surface these references.
Changes:
- Added REST overview + new endpoint docs for deploy webhooks, CI greenlight polling, and executable upload signed URLs.
- Added “Other CI” integration guides for Node.js (SDK) and non-Node environments (webhooks).
- Updated navigation and refreshed/extended several existing CI/CD docs (CircleCI, GitLab, mobile SDK guide).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| qawolf/v0-ci-greenlight.mdx | New REST endpoint doc for polling run outcome as a pipeline gate. |
| qawolf/run-inputs-executables-signed-urls.mdx | New REST endpoint doc for generating signed URLs + uploading executables. |
| qawolf/rest-overview.mdx | New REST API overview and endpoints index. |
| qawolf/other-ci-webhook.mdx | New integration guide for CI systems that can’t run Node.js (webhook-based). |
| qawolf/other-ci-node.mdx | New integration guide for generic CI systems that can run Node.js (SDK-based). |
| qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx | Reworked mobile CI SDK guide formatting and examples; added “Related”. |
| qawolf/GitLab-2a15b2a994fb805d9d14ff27726065ae.mdx | Added/adjusted verification + related links. |
| qawolf/environment_terminated.mdx | New webhook reference page for terminating ephemeral environments. |
| qawolf/deploy-success.mdx | New webhook reference page for deploy_success. |
| qawolf/circle-ci.mdx | Updated API key section heading and added “Related” section. |
| docs.json | Renamed “Libraries” tab to “References”, added REST group, and added new CI/CD guide pages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [QA Wolf CI SDK](/qawolf/Integrate-with-the-QA-Wolf-SDK-2db5b2a994fb8043be61f06f025d9c63) No newline at end of file | ||
| ## Related | ||
|
|
||
| - [QA Wolf CI SDK](/qawolf/qawolf/other-ci-node) No newline at end of file |
| Replace `$GIT_BRANCH` and `$GIT_COMMIT_SHA` with the environment variable names your CI system provides for the current branch and commit SHA. Replace `deployment_type` with the value your QA Wolf representative provides. Set `hosting_service` to where your code is hosted — `"GitHub"` or `"GitLab"` — not where your pipeline runs. | ||
|
|
||
| <Warning> | ||
| A 200 response does not guarantee a run was created. Inspect the response body to confirm. See [webhooks/deploy\_success](/rest/deploy-success) for full response details. |
| ## Related | ||
|
|
||
| - [`@qawolf/ci-sdk`](/libraries/ci-sdk) | ||
| - [CI greenlight](/rest/ci-greenlight) No newline at end of file |
| --- | ||
|
|
||
| <Tip> | ||
| For most use cases, [`@qawolf/ci-sdk`](/libraries/ci-sdk) is the recommended over direct endpoint access. |
| | Endpoint | Method | Description | | ||
| | --- | --- | --- | | ||
| | [`/api/webhooks/deploy_success`](/qawolf/deploy-success) | `POST` | Notify QA Wolf of a successful deployment to trigger a run. | | ||
| | [`/api/webhooks/environment_terminated`](/qawolf/environment-terminated) | `POST` | Notify QA Wolf that an ephemeral environment has been terminated. | |
|
|
||
| ## Related | ||
|
|
||
| - [`@qawolf/ci-sdk`](/qawolf/libraries/ci-sdk/api-reference) No newline at end of file |
|
|
||
| ## Related | ||
|
|
||
| - [`@qawolf/ci-sdk`](/qawolf/libraries/ci-sdk/api-reference) No newline at end of file |
| ## Related | ||
|
|
||
| - [`@qawolf/ci-sdk`](/libraries/ci-sdk) | ||
| - [Notify deploy](/qawolf/v0-ci-greenlight) No newline at end of file |
Comment on lines
+128
to
+137
| ## Verify the integration | ||
|
|
||
| <Steps> | ||
| <Step> | ||
| Push a new commit to your main branch and wait for your deployment to complete. | ||
| </Step> | ||
| <Step> | ||
| Open QA Wolf and confirm a new run appears under the expected environment. | ||
| </Step> | ||
| </Steps> |
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
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.
This creates 3 new documents in our Integrations->CI/CD section for Other Node.js, Webhook, and Other Node.js for mobile.
It create 4 new documents for our public endpoints/webhooks in the Libraries tab
It updates other document references and unifies some formatting
0 threads from 0 users in Mintlify