summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorTimothee Cour <timothee.cour2@gmail.com>2021-03-18 02:35:08 -0700
committerGitHub <noreply@github.com>2021-03-18 02:35:08 -0700
commitb755060f9c608292d4fd849cb876166950c4529a (patch)
treea1cfa17a478de024e97069cdaa7394ca989fc9b9 /doc
parent4bfc5a955120b90faf07f50b54ae29f2c6e6f123 (diff)
downloadNim-b755060f9c608292d4fd849cb876166950c4529a.tar.gz
docs contributing: mention https://man.sr.ht/builds.sr.ht/build-ssh.md for ssh to CI machines (#17409)
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst
index ba9c1caf3..b7188a436 100644
--- a/doc/contributing.rst
+++ b/doc/contributing.rst
@@ -488,7 +488,11 @@ Debugging CI failures, flaky tests, etc
     If either on you own fork or in Nim repo, it's possible from inside GitHub UI
     under checks tab, see https://github.com/timotheecour/Nim/issues/211#issuecomment-629751569
   * GitHub actions: under "Checks" tab, click "Re-run jobs" in the right.
-  * builds.sr.ht: create a sourcehut account so you can restart a PR job as illustrated
+  * builds.sr.ht: create a sourcehut account so you can restart a PR job as illustrated.
+    builds.sr.ht also allows you to ssh to a CI machine which can help a lot for debugging
+    issues, see docs in https://man.sr.ht/builds.sr.ht/build-ssh.md and
+    https://drewdevault.com/2019/08/19/Introducing-shell-access-for-builds.html; see
+    https://man.sr.ht/tutorials/set-up-account-and-git.md to generate and upload ssh keys.
 
 
 Code reviews