Document how to use in github actions

Offen
#2 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
github-actions
Bereich
ci-cd, documentation

Rechercherichtung

Beginne mit dem README und seinen vorhandenen Abschnitten zur Nutzung und prüfe anschließend, wie das Projekt in GitHub Actions ausgeführt wird. Die Aufgabe ist erledigt, wenn das README den angeforderten ptrace-Berechtigungsschritt für Benutzer von GitHub Actions dokumentiert, einschließlich des im Issue gezeigten Befehls.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation

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.

Vorherrschende Sprache
Python
Sterne
21
Forks
5
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus bloomberg/pytest-pystack

Alle Issues in bloomberg/pytest-pystack

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.