Formatter Action doesn't post comments when made from a fork

オープン
#489 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
github-actions, julia
領域
ci-cd, devops

調査の方向性

Formatter Action の設定と、リンクされたチェックの reviewdog 出力から始め、次に issue に示されている JuliaFormatter コマンドを使ってローカルでフォーマットを再現します。フォークからの pull request がどのようにトークンを受け取り、結果を報告するかを追跡します。クリック可能な提案を安全に投稿する方法を特定するか、それが不可能な場合にサポートされているフォールバックを文書化できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

When a PR is made from a fork the Formatter failed by doesn't post comments with clickable suggestions:
see: https://github.com/JuliaDiff/ChainRulesCore.jl/pull/488/checks?check_run_id=3854350212#step:5:187

reviewdog: This GitHub token doesn't have write permission of Review API [1],
so reviewdog will report results via logging command [2] and create annotations similar to
github-pr-check reporter as a fallback.
[1]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target,
[2]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#logging-commands

I am not sure if we can raise the permission on the GITHUB_TOKEN on a fork,
or if we can issue another token that has that permission?

But checks that fail without being easy to act upon suck.
This isn't super hard to do locally, I think it is just

using Pkg: @pkg_str
pkg"activate --temp"
pkg"add JuliaFormatter"
using JuliaFormatter; format("."; verbose=true)

But that is still work.

And especially for PR from newcomers (not @mcabbott 😂 ) who will always be making a PR from a fork, we want things to be smooth.

主要言語
Julia
スター
267
フォーク
66
平均マージ
1日 1時間
マージ済み PR(30日)
9

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

JuliaDiff/ChainRulesCore.jl のほかの issue

JuliaDiff/ChainRulesCore.jl の issue をすべて見る

似ている issue

Julia の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。