Code Monkey home page Code Monkey logo

ci-detective's Introduction

ci-detective

Simple utility to detect whether you are running in a CI server/environment

Latest Release GoDoc License Badge

Linux CI Badge Mac CI Badge Windows CI Badge

Go Report Card Test Results Badge Codecov Badge Sonar Quality Gate Badge


Installation

ci-detective is available as both an executable/cli and a package/api.

Grab a binary release or use go get:

go get -u github.com/swellaby/ci-detective

If you want to consume the package/api programmatically, just add the package import:

import (
    "github.com/swellaby/ci-detective/cidetective"
)

Usage

CLI

To use ci-detective as a CLI simply run the command:

ci-detective

The CLI will return an exit code of Zero if it detects the current environment is a CI engine/server. Otherwise it will return a non-Zero exit code.

Lib

The cidetective package exposes a single function: IsCI that returns a boolean indicating whether or not the current environment is a CI server/engine.

package main

import (
    "fmt"
    "github.com/swellaby/ci-detective/cidetective"
)

func main() {
    if cidetective.IsCI() {
        fmt.Println("Running in a CI environment!")
    } else {
        fmt.Println("Nope, this is NOT a CI environment!")
    }
}

Generator

Initially created by this swell generator!

ci-detective's People

Contributors

calebcartwright avatar renovate-bot avatar swellbot 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.