Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (stepci) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Step CI Banner

Welcome

Step CI is an open-source tool, which makes testing and monitoring APIs simple

Quick overview:

Language-agnostic. Flexible, declarative configuration language
REST, GraphQL, XML
Integrated. Works seamlessly with Node, Docker and GitHub Actions

Try Demo on our website

Join us on GitHub Discussions

Get started

Using Node

Install the CLI

npm install -g stepci

Create example test (tests/status.yml)

version: "1.0"
name: Status Check
env:
  host: example.com
steps:
  - name: GET request
    url: https://{{env.host}}
    method: GET
    check:
      status: /^20/

Run the test

stepci run tests/

Using Docker

Create example test (tests/status.yml)

version: "1.0"
name: Status Check
env:
  host: example.com
steps:
  - name: GET request
    url: https://{{env.host}}
    method: GET
    check:
      status: /^20/

Run the Docker image

docker run -v "$(pwd)"/tests:/tests ghcr.io/stepci/stepci tests/

Using GitHub Action

Create example test (tests/status.yml)

version: "1.0"
name: Status Check
env:
  host: example.com
steps:
  - name: GET request
    url: https://{{env.host}}
    method: GET
    check:
      status: /^20/

Add Step CI GitHub Action (./github/workflows/stepci.yml)

on: [push]
jobs:
  api_test:
    runs-on: ubuntu-latest
    name: API Tests
    steps:
      - uses: actions/checkout@v3
      - name: Step CI Action
        uses: stepci/stepci@main
        with:
          path: "tests/"

Documentation

Documentation is accessible under docs/

Example tests

You can find a collection of Step CI example tests under examples/

License

Step CI is distributed under Mozilla Public License terms