wiby

"Will I break you" - a tool for testing dependents

This repository is managed by the Package Maintenance Working Group, see Governance.

Pre-requisites

Github Token

wiby requires an environment variable GITHUB_TOKEN set to a Github access token. This token needs to be granted push permissions to the dependent repos.

Example: export GITHUB_TOKEN=XXXXX

For more information on creating a github token see Github's docs

Running location

wiby is designed to be run from inside the folder containing your source code. This folder needs to be a git repository with a package.json that contains information about the packages source on Github. Example:

{
...
  "repository": {
    "type": "git",
    "url": "https://github.com/ORGNAME/REPONAME.git"
  }
...
}

Available commands

wiby test Test your dependents

wiby result Fetch the results of your tests

Development

• This repository uses semantic-release with default configuration.
• Create a new release by running npx semantic-release.