{"id":30854432,"url":"https://github.com/sematext/synthetics-cicd","last_synced_at":"2026-02-13T05:04:13.258Z","repository":{"id":294417822,"uuid":"986259547","full_name":"sematext/synthetics-cicd","owner":"sematext","description":"The Sematext Synthetics CI/CD Action lets you run Synthetics tests within your CI/CD pipelines","archived":false,"fork":false,"pushed_at":"2025-05-26T09:01:20.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-07T10:40:07.515Z","etag":null,"topics":["cd","ci","ci-cd","cicd","continuous-delivery","continuous-integration","github-actions","synthetic-monitoring","testing"],"latest_commit_sha":null,"homepage":"https://sematext.com/docs/synthetics/ci-cd/overview/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sematext.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-19T10:45:57.000Z","updated_at":"2025-05-26T09:01:23.000Z","dependencies_parsed_at":"2025-05-22T06:46:54.804Z","dependency_job_id":null,"html_url":"https://github.com/sematext/synthetics-cicd","commit_stats":null,"previous_names":["sematext/synthetics-cicd"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sematext/synthetics-cicd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsynthetics-cicd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsynthetics-cicd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsynthetics-cicd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsynthetics-cicd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sematext","download_url":"https://codeload.github.com/sematext/synthetics-cicd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsynthetics-cicd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29396847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T04:26:15.637Z","status":"ssl_error","status_checked_at":"2026-02-13T04:16:29.732Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cd","ci","ci-cd","cicd","continuous-delivery","continuous-integration","github-actions","synthetic-monitoring","testing"],"created_at":"2025-09-07T10:40:05.602Z","updated_at":"2026-02-13T05:04:13.244Z","avatar_url":"https://github.com/sematext.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sematext Synthetics CI/CD\n\nThis GitHub Action allows you to trigger [Sematext Synthetics](https://sematext.com/docs/synthetics/) tests during your CI/CD workflows, enabling you to validate your deployments and ensure your applications are functioning correctly before pushing to production.\n\nRefer to our docs for a [detailed overview](https://sematext.com/docs/synthetics/ci-cd/overview/) of the features, [installation instructions](https://sematext.com/docs/synthetics/ci-cd/ci-cd-installation/) and [setup examples](https://sematext.com/docs/synthetics/ci-cd/ci-cd-installation/#examples) for different use-cases.\n\n\n\n## Prerequisites\n\nBefore you begin, make sure you have the following:\n- A Sematext Cloud account\n  - A two-week free trial with no CC info required is available for new users, and it lets you try out all of our features\n  - Click [here](https://apps.sematext.com/ui/registration) to register an account on our US region, or [here](https://apps.eu.sematext.com/ui/registration) for the EU region\n- Some CI/CD Synthetics Monitors configured on your Sematext Cloud account\n  - Setting up [Synthetics Monitors](https://sematext.com/docs/synthetics/getting-started/) is easy and takes less than 5 minutes per monitor\n- A Synthetics [CI/CD Group](https://sematext.com/docs/synthetics/ci-cd/overview/#cicd-groups) set up in your Sematext Cloud account\n  - A guide on setting this up can be found in the [installation instructions](https://sematext.com/docs/synthetics/ci-cd/ci-cd-installation/)\n- Your Sematext Cloud account's API key (found in Settings → API), which you'll need to add as a repository secret with the name `SEMATEXT_API_KEY`\n  - You can find it [here](https://apps.sematext.com/ui/account/api) if your account is registered in the US region, or [here](https://apps.eu.sematext.com/ui/account/api) for the EU region\n\n\n\n## Usage and Examples\n\nAdd the following to your GitHub workflow file:\n\n```yaml\nsteps:\n  - name: Run Sematext Synthetics Tests\n    uses: sematext/synthetics-cicd@v1.0.0\n    with:\n      MONITOR_GROUP_ID: 42                                          # Replace with your actual Monitor Group ID\n      REGION: 'US'                                                  # Replace with your Sematext Cloud account's region ('EU' or 'US')\n      SEMATEXT_API_KEY: ${{ secrets.SEMATEXT_API_KEY }}             # Make sure to add your Sematext API key as a repository secret first\n      TARGET_URL: 'https://your-deployment-url.com'                 # Pass dynamically from your setup, used as the replacement for \u003cDYNAMIC_URL\u003e\n      GIT_COMMIT_HASH: '5a24a0f8cd48be7f315787dcc23ad418ecdb36f2'   # Pass dynamically from your setup as needed\n      USE_HEAD_SHA: false                                           # Set to true if the invoking event is linked to the commit you're testing\n```\n\nSince these are Synthetic Monitoring tests, they'll need to run on a live environment. Depending on your deployment setup, it'll most likely mean triggering these tests on a successful `deployment_status` event or a `repository_dispatch` event. For *GitHub Workflow* examples showcasing how to run tests for both of these scenarios, check out our [docs](https://sematext.com/docs/synthetics/ci-cd/ci-cd-installation/#examples).\n\n\n\n## Inputs\n\n| Input | Description | Required |\n|-------|-------------|----------|\n| `MONITOR_GROUP_ID` | The ID of the *CI/CD Group* which contains the tests (e.g., `42`) | Yes |\n| `REGION` | The region where your Sematext Cloud account is registered (`EU` or `US`) | Yes |\n| `SEMATEXT_API_KEY` | Your Sematext Cloud account's API key | Yes |\n| `TARGET_URL` | The URL to run the Synthetics tests against - mandatory for monitors with [Dynamic URLs](https://sematext.com/docs/synthetics/ci-cd/overview/#dynamic-urls) | No |\n| `GIT_COMMIT_HASH` | The commit hash that the Synthetics tests will be triggered for | No |\n| `USE_HEAD_SHA` | Whether to use the HEAD SHA for the Synthetics tests | No |\n\n\u003e **Note**: Either `GIT_COMMIT_HASH` must be provided or `USE_HEAD_SHA` must be set to `true`.\n\n\n\n## Outputs\n\n| Output | Description |\n|--------|-------------|\n| `result` | The full result output from the Synthetics *Group Run* |\n| `status` | The status of the *Group Run* (`passed` or `failed`) |\n| `error` | The error message if the *Group Run* failed |\n| `group_run_url` | The URL of the *Group Run* in the Sematext Cloud UI |\n\n\n\n## Useful Resources\n\nHere are some resources that can help you learn more about the Action, and about Sematext Synthetics in general:\n- [Sematext Synthetics Overview](https://sematext.com/synthetic-monitoring/)\n- [Sematext Synthetics Docs](https://sematext.com/docs/synthetics/)\n- [Sematext Synthetics FAQ](https://sematext.com/docs/synthetics/faq/)\n- [Sematext Synthetics CI/CD Integration Docs](https://sematext.com/docs/synthetics/ci-cd/overview/)\n\nIf you encounter issues with Sematext Synthetics or setting up the Action, just email support@sematext.com and we'll help you out ASAP.\n\nIf you're already using various workflows that create *check suites* in your repository along with a `repository_dispatch` event to trigger the Action, then please read [this page](https://sematext.com/docs/synthetics/ci-cd/ci-cd-check-run-fix/) to learn how to circumvent the limitations tied to GitHub's *check-runs* API.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsematext%2Fsynthetics-cicd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsematext%2Fsynthetics-cicd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsematext%2Fsynthetics-cicd/lists"}