Socket
Book a DemoInstallSign in
Socket

specmatic-insights-github-build-reporter

Package Overview
Dependencies
Maintainers
3
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

specmatic-insights-github-build-reporter

Specmatic Insights Github build reporter

1.1.2
latest
npmnpm
Version published
Weekly downloads
15
7.14%
Maintainers
3
Weekly downloads
 
Created
Source

Specmatic Insights Github Build Reporter

This package runs as part of your CI pipeline to ship Specmatic reports to Specmatic Insights.

Please contact Specmatic team for more info.

Docker Usage in GitHub Actions

- name: Run Specmatic Insights Github Build Reporter
  run: |
    docker run \
      -v ${{ github.workspace }}:/workspace \
      specmatic/specmatic-insights-github-build-reporter:latest \
        --specmatic-insights-host https://insights.specmatic.io \
        --specmatic-reports-dir /workspace/build/reports/specmatic \
        --org-id ${{ secrets.SPECMATIC_ORG_ID }} \
        --branch-name ${{ github.ref_name }} \
        --repo-name ${{ github.event.repository.name }} \
        --repo-id ${{ github.repository_id }} \
        --repo-url ${{ github.event.repository.html_url }}

Direct NPM Usage in GitHub Actions

- name: Run Specmatic Insights Github Build Reporter
  run: |
    npx specmatic-insights-github-build-reporter \
      --org-id ${{ secrets.SPECMATIC_ORG_ID }} \
      --branch-name ${{ github.ref_name }} \
      --repo-name ${{ github.event.repository.name }} \
      --repo-id ${{ github.repository_id }} \
      --repo-url ${{ github.event.repository.html_url }}

Testing locally

Before you're able to test locally, you'll have to link the specmatic-insights-github-build-reporter package to your local npm registry.

Run the following command in the root directory of the specmatic-insights-github-build-reporter package:

npm link

Next, link the specmatic-insights-github-build-reporter package to your local npm registry in the root directory of your specmatic project, e.g. specmatic-order-api-java:

npm link specmatic-insights-github-build-reporter

Now you can run the build reporter locally to send builds to your local insights server using the following command:

npx specmatic-insights-github-build-reporter \
  --specmatic-insights-host=http://localhost:8080 \
  --org-id <org-id> \
  --branch-name <branch-name> \
  --repo-name <repo-name> \
  --repo-id <repo-id> \
  --repo-url <repo-url>

To revert the changes, run the following commands:

npm unlink specmatic-insights-github-build-reporter
npm unlink

FAQs

Package last updated on 15 Jul 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.