Skip to content

Document Resyntax's GitHub integration #801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jackfirth wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Document Resyntax's GitHub integration #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions github.scrbl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#lang scribble/manual


@title[#:tag "github"]{Resyntax on GitHub}


In addition to the @secref["cli"], Resyntax integrates with GitHub in two ways: an @deftech{analyzer}
that reviews pull requests, and an @deftech{autofixer} that periodically opens pull requests cleaning
up a repository.

The @tech{analyzer} runs on each pull request, leaving review comments with the suggestions Resyntax
would make for the changed code. You can find reviews the analyzer has left on pull requests
@hyperlink["https://github.com/search?q=%22Resyntax%20analyzed%22%20%22added%20suggestions%22%20in%3Acomments%20is%3Apr%20sort%3Aupdated%20&type=pullrequests"]{
in the wild} using GitHub search.

The @tech{autofixer} runs on a schedule, applying Resyntax's suggestions to a repository and opening a
pull request with the results. Pull requests created by the autofixer can be found
@hyperlink["https://github.com/search?q=author%3Aapp%2Fresyntax-ci&type=pullrequests"]{using this
search}.
1 change: 1 addition & 0 deletions main.scrbl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ To see a list of suggestions that Resyntax would apply, use @exec{resyntax analy


@include-section[(lib "resyntax/cli.scrbl")]
@include-section[(lib "resyntax/github.scrbl")]
@include-section[(lib "resyntax/refactoring-rules.scrbl")]
@include-section[(lib "resyntax/testing.scrbl")]
@include-section[(lib "resyntax/grimoire.scrbl")]
Loading