Bytesalt is platform-agnostic and works with any CI/CD provider that can run a shell script. This repository contains examples to help you get started with several popular platforms.
src/: A simple Node.js application used as a target for automated tests..github/workflows/: GitHub Actions integration example..gitlab-ci.yml: GitLab CI integration example..circleci/: CircleCI integration example.scripts/: Reusable provider-specific scripts that fetch pull/merge request details and changes via API.
To use Bytesalt in your CI/CD pipeline, you generally need to:
- Configure Credentials: Login to bytesalt.com and navigate to the Machine Users section. Create a new client to generate your
BYTESALT_CLIENT_IDandBYTESALT_CLIENT_SECRET, then add them (along with any provider-specific tokens) as Secrets or Secured Variables in your CI/CD platform. Check the individual example files below for specific requirements. - Install the CLI: Use our installation script within your CI pipeline to download the binary:
curl -fsSL https://bytesalt.com/install | sh - Run Tests: Use the
bytesalt startcommand to trigger a test job.
Bytesalt is platform-agnostic and can be integrated into any CI/CD pipeline that supports running a shell script. Below are configuration examples for some popular providers:
| Provider | Example File |
|---|---|
| GitHub Actions | .github/workflows/bytesalt.yml |
| GitLab CI | .gitlab-ci.yml |
| CircleCI | .circleci/config.yml |
| Bitbucket Pipelines | bitbucket-pipelines.yml |
| Azure Pipelines | azure-pipelines.yml |
| Jenkins | Jenkinsfile |
For full details on CLI commands and advanced usage, visit our official documentation.