bloomberg / bloomberg/pytest-pystack

Document how to use in github actions

オープン
#2 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
documentation
主要言語
Python
スター
21
フォーク
5
PR マージ指標
30日以内にマージされた PR はありません

説明

Users might get the following error in CI:
```
💀 Engine error: No such process 💀

The specified process cannot be traced. This could be because the tracer
has insufficient privileges (the required capability is CAP_SYS_PTRACE).
Unprivileged processes cannot trace processes that they cannot send signals
to or those running set-user-ID/set-group-ID programs, for security reasons.
Alternatively, the process may already be being traced.

If your uid matches the uid of the target process you want to analyze, you
can do one of the following to get 'ptrace' scope permissions:

* If you are running inside a Docker container, you need to make sure you
start the container using the '--cap-add=SYS_PTRACE' or '--privileged'
command line arguments. Notice that this may not be enough if you are not
running as 'root' inside the Docker container as you may need to disable
hardening (see next points).

* Try running again with elevated permissions by running 'sudo -E !!'.

* You can disable kernel hardening for the current session temporarily (until
a reboot happens) by running 'echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope'.
```

Rather than waiting for them to get the error to notice it, document that when running in github actions they should have a step that runs `echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope`.

We can add this in a section of the README file.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず README と既存の使用方法のセクションを確認し、その後、GitHub Actions でプロジェクトがどのように実行されているかを確認します。README に、GitHub Actions ユーザー向けに要求された ptrace 権限設定の手順が、issue に示されたコマンドを含めて記載されていれば完了です。

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

評価

技術スタック
github-actions
領域
ci-cd, documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
45/100

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

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