Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.29 KB
Raw

Contributing

Development

After cloning the repository locally, run:

composer install

To run the locally checked-out version of the CLI tool, use php spinupwp from within the repository's root.

If you would like to use the CLI tool against a local version of the SpinupWP API. Open your ~/.spinupwp/config.json file and add api_url to a profile.

{
    "default": {
        "api_url": "http:\/\/api.spinupwp.test\/v1\/",
        "api_token": "eyJ...",
        "format": "table"
    }
}

Releasing a New Version

Update the version in config/app.php to reflect the new release. Ensure you follow Semantic Versioning.

Then, build a new version of the CLI tool:

php spinupwp app:build spinupwp

Commit the changes to the main branch.

On GitHub, create a new release. Set the tag and release title to the semantic version, but prepend the letter v. For example, if releasing version 1.1.1, the tag and release title should be v1.1.1. Leave target set to main and add any release notes to the description field.

Hit 'Publish release' to finalize the release. This will automatically update Packagist with the latest version.