Skip to content

Document Resyntax's GitHub integrations #837

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

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

Document Resyntax's GitHub integrations #837

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
27 changes: 27 additions & 0 deletions github.scrbl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#lang scribble/manual


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


Resyntax integrates with GitHub in two ways. The @emph{analyzer} reviews pull requests, leaving
Resyntax's suggestions as review comments on the lines they apply to. The @emph{autofixer}
periodically runs over an entire repository and opens a pull request applying the fixes it finds,
cleaning the repository up over time. Both are GitHub Actions workflows built on the
@exec{resyntax analyze} and @exec{resyntax fix} commands described in @secref["cli"].

Reviews the analyzer has left on pull requests in the wild can be found with
@hyperlink["https://github.com/search?q=%22Resyntax%20analyzed%22%20%22added%20suggestions%22%20in%3Acomments%20is%3Apr%20sort%3Aupdated%20&type=pullrequests"]{
this GitHub search}, and pull requests opened by the autofixer can be found with
@hyperlink["https://github.com/search?q=author%3Aapp%2Fresyntax-ci&type=pullrequests"]{this one}.

The analyzer is split into two workflows: one that analyzes the code and uploads the analysis as an
artifact, and one that downloads the artifact and submits it as a pull request review. The analyzing
workflow checks out and compiles the pull request's branch, so it runs with read-only repository
permissions; the submitting workflow needs write permissions but never executes any of the
repository's code. This division lets pull requests from forks be analyzed safely. Resyntax's own
repository uses this setup, in
@hyperlink["https://github.com/jackfirth/resyntax/blob/master/.github/workflows/resyntax-analyze.yml"]{
@tt{resyntax-analyze.yml}} and
@hyperlink["https://github.com/jackfirth/resyntax/blob/master/.github/workflows/resyntax-submit-review.yml"]{
@tt{resyntax-submit-review.yml}}.
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