Merge pull request #601 from mashehu/add-self-hosted-runners

add profile for self-hosted runners
nf-core · Dec 4, 2023 · ca58de1 · ca58de1
2 parents 60de593 + 0b82730
commit ca58de1
Show file tree

Hide file tree

Showing 5 changed files with 138 additions and 111 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -7,15 +7,15 @@ jobs:
     runs-on: ubuntu-latest
     name: Check if all profiles are tested
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Check whether profiles are all tested
         run: python ${GITHUB_WORKSPACE}/bin/cchecker.py ${GITHUB_WORKSPACE}/nfcore_custom.config ${GITHUB_WORKSPACE}/.github/workflows/main.yml
 
   check_nextflow_config:
     runs-on: ubuntu-latest
     name: Check if nextflow config runs in repository root
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Install Nextflow
         run: |
           wget -qO- get.nextflow.io | bash
@@ -112,6 +112,7 @@ jobs:
           - "sanger"
           - "scw"
           - "seawulf"
+          - "self_hosted_runner"
           - "seg_globe"
           - "software_license"
           - "tigem"
@@ -138,7 +139,7 @@ jobs:
           - "xanadu"
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Install Nextflow
         run: |
           wget -qO- get.nextflow.io | bash

diff --git a/README.md b/README.md
@@ -167,6 +167,7 @@ Currently documentation is available for the following systems:
 - [SANGER](docs/sanger.md)
 - [SEAWULF](docs/seawulf.md)
 - [SEG_GLOBE](docs/seg_globe.md)
+- [self-hosted-runner](docs/self-hosted-runner.md)
 - [Super Computing Wales](docs/scw.md)
 - [TIGEM](docs/tigem.md)
 - [TUBINGEN_APG](docs/tubingen_apg.md)

diff --git a/conf/self_hosted_runner.config b/conf/self_hosted_runner.config
@@ -0,0 +1,21 @@
+// Config file for nf-core's self-hosted-runners
+
+//Profile config names for nf-core/configs
+params {
+    config_profile_description = "Profile for nf-core's self-hosted runners provided by nf-core/configs."
+    config_profile_contact = 'Matthias Hörtenhuber (@mashehu)'
+    config_profile_url = 'https://github.com/nf-core/actions-runners'
+
+
+    // General cpus/memory/time requirements
+    max_cpus = 2
+    max_memory = 7.GB
+    max_time = 72.h
+}
+
+docker {
+    enabled = true
+    docker.userEmulation = true
+    docker.runOptions = '--platform=linux/amd64'
+}
+
diff --git a/docs/self_hosted_runner.md b/docs/self_hosted_runner.md
@@ -0,0 +1,3 @@
+# nf-core/configs: self-hosted-runner Configuration
+
+To use, run the pipeline with `-profile self-hosted-runner`. This will download and launch the [`self-hosted-runner.config`](../conf/self-hosted-runner.config) which has been pre-configured with a setup suitable for the self-hosted-runners (for now on AWS via terraform). The main aim of this profile is to fix the permission errors on self-hosted GitHub actions runners.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# nf-core/configs: self-hosted-runner Configuration

		To use, run the pipeline with `-profile self-hosted-runner`. This will download and launch the [`self-hosted-runner.config`](../conf/self-hosted-runner.config) which has been pre-configured with a setup suitable for the self-hosted-runners (for now on AWS via terraform). The main aim of this profile is to fix the permission errors on self-hosted GitHub actions runners.