garciparedes / restyler

The restyling process, as a CLI

Restyler

The restyling process, as a CLI.

Usage

docker run --rm \
  --env "GITHUB_ACCESS_TOKEN=<access-token>" \
  --volume /tmp:tmp \
  --volume /var/run/docker.sock:/var/run/docker.sock \
  restyled/restyler "<owner>/<name>#<number>"

NOTE: The Access Token you use will determine some of the resulting behavior. In production, we use a token provisioned for an installed instance of our GitHub App, which ensures the restyled PRs and comments appear as authored by our App. If you use a Personal Access Token, the restyled PRs and comments will be authored by your user.

Development

make

Requires stack.

Tests

make test

Integration

End-to-end test that restyles an example Pull Request:

make test.integration

NOTE: This only works if you have local keys for our development GitHub App (i.e. bin/get-access-token works).

restyle-path

See bin/restyle-path.

LICENSE

Restyled is source-available, Commons Claused licensed. For a detailed description of another project's rationale for this licensing model, one with which I agree, see here.

---

CHANGELOG | LICENSE | CONTRIBUTING