Skip to content

Create test.md - #4

Open
SnowCait wants to merge 5 commits into
mainfrom
SnowCait-patch-2
Open

Create test.md#4
SnowCait wants to merge 5 commits into
mainfrom
SnowCait-patch-2

Conversation

@SnowCait

Copy link
Copy Markdown
Member

No description provided.

@tsuyoshicho

Copy link
Copy Markdown

@SnowCait さん、 @mattn さんから action-textlint が問題あるのではという相談を受けました。

確認してみましたが、次の理由から正常動作と思われます。

処理結果
CIでは


  /home/runner/work/sandbox/sandbox/README.md
    4:4  ✔   文末が"。"で終わっていません。  ja-technical-writing/ja-no-mixed-period
  
  ✔ Fixed 1 problem
  
  Saved working directory and index state WIP on SnowCait-patch-2: e997f59 Create test.md
  Dropped refs/stash@{0} (e9d3828e9843d1afd49e254b5360657aaa7cdf39)
  ::endgroup::

と出力されていますし、ローカルで実行しても

 snow-action-sandbox on  SnowCait-patch-2 via  v21.1.0 took 45s
⏰[2023-10-26T06:09:37+09:00] $✔️ npx textlint README.md

D:\Data\ReposWork\git\snow-action-sandbox\README.md
  4:4  ✓ error  文末が"。"で終わっていません。  ja-technical-writing/ja-no-mixed-period

✖ 1 problem (1 error, 0 warnings)
✓ 1 fixable problem.
Try to run: $ textlint --fix [file]

exit status 1
 snow-action-sandbox on  SnowCait-patch-2 via  v21.1.0 took 2s
⏰[2023-10-26T06:09:56+09:00] $✔️ npx textlint -f unix README.md
D:\Data\ReposWork\git\snow-action-sandbox\README.md:4:4: 文末が"。"で終わっていません。 [Error/ja-technical-writing/ja-no-mixed-period]

1 problem
exit status 1
 snow-action-sandbox on  SnowCait-patch-2 via  v21.1.0 took 3s
⏰[2023-10-26T06:10:08+09:00] $✔️ npx textlint -f checkstyle README.md
<?xml version="1.0" encoding="utf-8"?><checkstyle version="4.3"><file name="D:\Data\ReposWork\git\snow-action-sandbox\README.md"><error line="4" column="4" severity="error" message="文末が&quot;。&quot;で終わっていません。 (ja-technical-writing/ja-no-mixed-period)" source="eslint.rules.ja-technical-writing/ja-no-mixed-
period" /></file></checkstyle>
exit status 1
 snow-action-sandbox on  SnowCait-patch-2 via  v21.1.0 took 3s
⏰[2023-10-26T06:10:30+09:00] $✔️

ちゃんと1つNGが取れています。

自分の所のPRでは、(権限やpull_request_targetではないですが)問題ありませんでした
tsuyoshicho/action-test-repo#37

  • NGについて fail_on_error : true で失敗になるのは正常
  • デフォルトの repoter (github-pr-review) で結果がでないのはおかしい

後者についてですが、pull_request_target を pull_request にし、 permission をデフォルトにして試してみるのはどうでしょうか?

おおよその挙動自体は正常に動いているし、エラーしているわけではないようなので、上記で見ていただきたいです。

@tsuyoshicho

Copy link
Copy Markdown

@SnowCait

SnowCait commented Aug 4, 2024

Copy link
Copy Markdown
Member Author

@tsuyoshicho
すみません、このリポジトリは通知を切っているのでコメントに気付いていませんでした。
時間が空いてしまったので若干記憶が曖昧なのですが reviewdog はデフォルトでは PR の差分のみをチェックの対象(オプションの filter_mode: added)とするので差分外であるファイル (README.md) のエラーが検出されているのはおかしいのではないかという指摘だったように思います。

@tsuyoshicho

Copy link
Copy Markdown

試して確認します(ログ飛んでるので)

@tsuyoshicho

Copy link
Copy Markdown

コードの机上デバッグで判明しましたので連絡します。

  • action-textlint では、reporterのデフォルトが github-pr-review になっています(修正差分を出す)
  • github-pr-review では、一度変更したときのdiffをreviewdogに渡す
  • その都合として、そちらの動作のときは、filter_mode に diff_context を固定設定する(ミス1: diffはこれが必要と思っていた)
  • また、そのときは reviewdog のエラーコードのケアができていなかった(ミス2: 先に指摘のための処理をしているので、こちらは無視してよかった)

この点について修正します。

@tsuyoshicho

tsuyoshicho commented Aug 5, 2024

Copy link
Copy Markdown

tsuyoshicho/action-test-repo#45
修正はうまく動いているようです。マージしてリリースしますので、リリース後のaction-textlintでrerunさせてみてください

リリースしました、このPRをrerunもしくは空コミットしていただきたいです

@SnowCait

SnowCait commented Aug 5, 2024

Copy link
Copy Markdown
Member Author

修正ありがとうございます、コミットを足してみたのですが期待通りの結果にならずこちらのリポジトリ側の問題かもしれないのでちょっと確認中です。(修正差分をちらっと見た感じは良さそうに見えるのですが…)

@SnowCait

SnowCait commented Aug 5, 2024

Copy link
Copy Markdown
Member Author

script.sh を確認していたところ、textlint_exit_val の値が 1 になって失敗しているようでした。
textlint の実行自体は全体が対象なのでこれは正しいですが、アクションの結果としては差分 (added) だけを対象にしたいのでこの値は無視した方が良さそうです。
-filter-mode および -fail-on-error が適用された reviewdog の結果 (reviewdog_exit_val) をアクション実行の結果として適用する PR (tsuyoshicho/action-textlint#426) をお送りしましたのでお時間あるときにでもご確認いただけると幸いです。
動作確認は #7 で行いました。(filter_mode: added の動作のみ確認してます)

@tsuyoshicho

Copy link
Copy Markdown

@SnowCait
action-textlint v3.9.2 修正リリースが完了しました。

確認してみてください

@SnowCait

SnowCait commented Aug 7, 2024

Copy link
Copy Markdown
Member Author

PR の方へコメントしました
一応動作確認に使ったコミットも置いておきます。#7 で同様の動作確認を行いました。
SnowCait/action-textlint@81a0701

@tsuyoshicho

Copy link
Copy Markdown

お手数かけました、こんどこそちゃんと動くはず

@SnowCait

SnowCait commented Aug 7, 2024

Copy link
Copy Markdown
Member Author

ありがとうございます!期待する挙動になりました~🎉💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants