@sentinelqa/uploader
v0.1.37
Published
Sentinel uploader CLI for CI/CD debugging artifacts
Maintainers
Readme
@sentinelqa/uploader
Low-level Sentinel uploader CLI for Playwright artifacts and hosted Sentinel run links.
@sentinelqa/playwright-reporter is the recommended integration for most teams.
Use this package only if you need direct CLI control or custom wrapper behavior.
Install
npm i -D @sentinelqa/uploaderUsage
sentinelqa upload --playwright-json-path test-results/report.jsonDirect upload after tests already ran:
npx @sentinelqa/uploader upload --playwright-json-path test-results/report.jsonUniversal wrapper for custom commands:
npx @sentinelqa/uploader run -- <your test command>Playwright Failure Context Capture (DOM + Mutation Signals)
Add this helper to capture DOM target state and mutation signals on failures:
import { sentinelCaptureFailureContext } from "@sentinelqa/uploader/playwright";
test.afterEach(async ({ page }, testInfo) => {
await sentinelCaptureFailureContext(page, testInfo);
});This writes dom-capture-*.json to test-results/sentinel-dom/ and attaches it to the Playwright report so the uploader can associate it with the correct test.
Environment Variables
SENTINEL_TOKEN(optional; required only for uploading into a specific Sentinel workspace)SENTINEL_TEST_EXIT_CODE(optional; set automatically by the wrapper)SENTINEL_REQUEST_TIMEOUT_MS(optional; override API request timeout, default45000)SENTINEL_UPLOAD_TIMEOUT_MS(optional; override artifact upload timeout, default120000)
Optional: BYO S3 (Advanced)
Set these to upload directly to your own bucket:
SENTINEL_S3_ENDPOINT(optional for AWS)SENTINEL_S3_REGIONSENTINEL_S3_BUCKETSENTINEL_S3_PREFIX(optional)SENTINEL_S3_ACCESS_KEY_IDSENTINEL_S3_SECRET_ACCESS_KEY
Troubleshooting
Missing artifacts
- Ensure Playwright outputs are present:
- a Playwright JSON report
playwright-report/test-results/
401 Unauthorized
- Check
SENTINEL_TOKENand project permissions if you are uploading into a workspace.
Custom app URL override
- Custom
SENTINEL_URLorAPP_URLvalues are not supported. - Sentinel uploads always target
https://app.sentinelqa.com.
No CI metadata
- The uploader detects GitLab, GitHub, CircleCI, or local git metadata.
No failed tests
- Ensure
@playwright/testis installed and the JSON reporter is enabled.
BYO uploads failing
- Verify
SENTINEL_S3_*values and permissions.
