Rich-codex screenshot in the readme

.github/workflows/multiqc_linux.yml

@@ -11,28 +11,26 @@ jobs:
     timeout-minutes: 10
 
     steps:
-      # Check out MultiQC code
-      - uses: actions/checkout@v2
+      - name: Check out MultiQC code
+        uses: actions/checkout@v2
 
-      # Set up Python
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
 
-      # Update pip and install beautifulsoup4 for CI tests (CSP checking)
+      # For CSP checking
       - name: Install dependencies for CI tests
-        run: |
-          python -m pip install --upgrade pip setuptools beautifulsoup4
+        run: python -m pip install --upgrade pip setuptools beautifulsoup4
 
-      # Install MultiQC
       - name: Install MultiQC
         run: pip install .
 
-      # Fetch the MultiQC test data
       - name: Download test data
-        run: |
-          git clone https://github.com/ewels/MultiQC_TestData.git test_data
+        uses: actions/checkout@v3
+        with:
+          repository: ewels/MultiQC_TestData
+          path: test_data
 
       # Run all of the tests!
       - name: Special case input data

.github/workflows/screenshots.yml

@@ -0,0 +1,29 @@
+name: Docs screenshots
+on: [push]
+
+jobs:
+  rich_codex:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out MultiQC code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+
+      - name: Install MultiQC
+        run: pip install .
+
+      - name: Download test data
+        run: |
+          wget https://github.com/ewels/MultiQC_TestData/archive/refs/heads/master.zip
+          unzip master.zip
+          mv MultiQC_TestData-master/ test_data/
+
+      - name: Generate terminal images with rich-codex
+        uses: ewels/rich-codex@v1
+        with:
+          clean_img_paths: |
+            docs/images/screenshots/*.svg
+            test_data
+          commit_changes: "true"

README.md

@@ -73,6 +73,10 @@ multiqc .
 That's it! MultiQC will scan the specified directory (`.` is the current dir)
 and produce a report detailing whatever it finds.
 
+<!-- RICH-CODEX fake_command: "multiqc ." -->
+
+![`cd test_data/data/modules/fastqc/v0.10.1 && multiqc .`](docs/images/screenshots/fastqc-run.svg)
+
 The report is created in `multiqc_report.html` by default. Tab-delimited data
 files are also created in `multiqc_data/`, containing extra information.
 These can be easily inspected using Excel (use `--data-format` to get `yaml`