Giter Club home page Giter Club logo

swiple-action's Introduction

Swiple Dataset Validation Action

This GitHub action automatically validates datasets, polls task status, and displays validation results in a GitHub pull request. It is designed to work with Swiple's dataset validation API.

Features

  • Authenticate with the Swiple API using provided credentials
  • Run dataset validation and obtain a task ID
  • Poll the task status until it reaches a final state (SUCCESS, FAILURE, or ERROR)
  • Retrieve the most recent validation results for a specific dataset ID
  • Display validation results as a table in the GitHub pull request

Usage

To use this action, you need to add it as a step in your GitHub Actions workflow file (.github/workflows/main.yml or similar). Here's an example workflow:

name: Swiple Dataset Validation

on: [pull_request]

jobs:
  validate-dataset:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository
      uses: actions/checkout@v3
        
    - name: Validate Dataset
      uses: Swiple/swiple-action@v1
      with:
        api_base_url: 'https://swiple.api.yourdomain.io'
        ui_base_url: 'https://swiple.app.yourdomain.io'
        dataset_id: 'your_dataset_id'
        username: ${{ secrets.API_USERNAME }}
        password: ${{ secrets.API_PASSWORD }}
        github_token: ${{ secrets.GITHUB_TOKEN }}
        require_all_passed: 'true'  # OPTIONAL: Causes build to fail if any expectations fail

swiple-action's People

Contributors

kentonparton avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.