feat(screenshots): saving screenshots as artifacts

kensho · Jul 12, 2016 · 2a18974 · 2a18974
1 parent f0823d8
commit 2a18974
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -141,6 +141,22 @@ To print debug messages during the build, start the tool with environment variab
 DEBUG=multi ...
 ```
 
+The generated GitLab CI also collects the screenshots collected by Cypress as artifacts
+
+```
+.job_template: &e2e_test_definition
+  artifacts:
+    when: on_failure
+    expire_in: 1 month
+    paths:
+    - cypress/screenshots/
+  script:
+    - cypress ci --spec "output/$CI_BUILD_NAME.js"
+```
+
+This should help debug test problems, because Cypress should save the screenshots on failure
+when running in the CI mode.
+
 ### Small print
 
 Author: Kensho, Gleb Bahmutov &lt;[email protected]&gt; &copy; 2016

diff --git a/src/generate-gitlab-file.js b/src/generate-gitlab-file.js
@@ -80,6 +80,11 @@ build-specs:
 # Hidden job that defines an anchor named 'e2e_test_definition'
 # This job will be automatically assigned "test" phase
 .job_template: &e2e_test_definition
+  artifacts:
+    when: on_failure
+    expire_in: 1 month
+    paths:
+    - cypress/screenshots/
   script:
 `
   script.forEach((testCommand) => {

diff --git a/test/.gitlab-ci.yml b/test/.gitlab-ci.yml
@@ -37,6 +37,11 @@ build-specs:
 # Hidden job that defines an anchor named 'e2e_test_definition'
 # This job will be automatically assigned "test" phase
 .job_template: &e2e_test_definition
+  artifacts:
+    when: on_failure
+    expire_in: 1 month
+    paths:
+    - cypress/screenshots/
   script:
     - cypress ci --spec "output/$CI_BUILD_NAME.js"
 

diff --git a/test2/.gitlab-ci.yml b/test2/.gitlab-ci.yml
@@ -37,6 +37,11 @@ build-specs:
 # Hidden job that defines an anchor named 'e2e_test_definition'
 # This job will be automatically assigned "test" phase
 .job_template: &e2e_test_definition
+  artifacts:
+    when: on_failure
+    expire_in: 1 month
+    paths:
+    - cypress/screenshots/
   script:
     - cypress ci --spec "cypress/integration/$CI_BUILD_NAME.js"
 

diff --git a/test4/.gitlab-ci.yml b/test4/.gitlab-ci.yml
@@ -37,6 +37,11 @@ build-specs:
 # Hidden job that defines an anchor named 'e2e_test_definition'
 # This job will be automatically assigned "test" phase
 .job_template: &e2e_test_definition
+  artifacts:
+    when: on_failure
+    expire_in: 1 month
+    paths:
+    - cypress/screenshots/
   script:
     - cypress ci --spec cypress/integration/$CI_BUILD_NAME.js --reporter json
   after_script: