Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

slack-cypress-reporter-jenkins

A slack reporter for mochawesome reports generated by Cypress or other test frameworks using Mocha, for runs generated on Jenkins

cypress, slack, jenkins, reporter, mocha, mochawesome, mochawesome-merge, marge

readme

cypress-slack-reporter-jenkins

A Slack Reporting tool built for Cypress but should work with any mocha based framework that is using mochawesome

This repo is a fork from https://github.com/YOU54F/cypress-plugins with some customizations with respect to jenkins ci provider

How to install?

You can add the dependency of this package into your JS project by :- npm install slack-cypress-reporter-jenkins --save-dev

How to send slack notification of the cypress report using this package?

You need to set following environment variables before using this package to send notifications:-

  • E2E_REPORT_URL :- URL of your cypress test HTML report of the current Jenkins run or any other tool where you are storing the report
  • APP_NAME :- Name of the app under test, e.g. Kamernet BackOffice Or Kamernet Web
  • SLACK_WEBHOOK_URL :- url of your slack webhook (created via your slack app)

Once you have executed the cypress tests via jenkins and saved the Mochawesome report(s) in a directory named cypress/reports in your root folder -> you need to execute following command to send the slack notification :-

node_modules/.bin/slack-cypress-reporter-jenkins --ci-provider jenkins --report-dir cypress/reports

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.3.0 (2021-05-05)

Bug Fixes

  • deps: update dependency @slack/types to v2 (#927) (4204157)
  • deps: update dependency @slack/webhook to v6 (#928) (367b4c4)
  • deps: update dependency commander to v7 (#931) (3040a78)
  • deps: update dependency del to v6 (#800) (cf58e64)

1.2.1 (2021-05-05)

1.2.0 (2021-05-05)

1.1.9-alpha (2021-04-29)

Bug Fixes

  • #984 - more appropriate error msg when no html reports found (f7ba134)
  • split filename from artefact paths, globby win fix, dotenv config (aa34bbf)
  • update artefact path for screenshots and videos (0a5e7b7)

1.0.3 (2020-08-12)

Bug Fixes

  • add missing artefacts from messages post refactor (4f61458)

1.0.2 (2020-07-19)

1.0.0 (2020-07-19)

Features

  • allow accessControlLevel to be set in s3-batch-upload (797bf8b)
  • async refactor + customText, fault tolerant and initial BB support (4c4a602)
  • s3 uploader works and returns upload paths (90d7e85)

0.10.0 (2020-07-05)

Features

  • allow multiple webhooks per msg and diff hook per status (ba14f5c)

0.9.0 (2020-06-10)

0.8.0 (2020-05-26)

Features

  • ci-provider: added option for Jenkins CI provider (#321) (7a5552f)

0.7.1 (2020-05-18)

Features

0.7.0 (2020-05-18)

0.6.0 (2020-05-11)

0.5.7 (2020-05-11)

0.5.6 (2020-05-11)

Bug Fixes

  • deps: update dependency commander to v5 (#481) (060b999)

0.5.5 (2020-02-24)

Bug Fixes

  • remove base path from readme & cli runner (1c2f88e)

0.5.4 (2020-02-24)

Bug Fixes

0.5.3 (2020-02-14)

Bug Fixes

  • update reportDir in cli runner (f506816)

0.5.2 (2020-02-14)

0.5.1 (2020-02-12)

0.4.7 (2020-02-12)

0.4.6 (2020-02-12)

Bug Fixes

  • update docs and add overwrite correction for cli (#422) (b7673da)
  • deps: update dependency commander to v4 (#288) (354242d)

0.5.0 (2019-11-01)

Features

  • added support for circle ci job name under slack report messgae by @uxi187 (c36fc7b)

0.4.4 (2019-10-17)

Bug Fixes

  • deps: update dependency commander to v3 (#174) (e730eba)

0.4.3 (2019-08-07)

0.4.2 (2019-07-08)

0.4.1 (2019-07-08)

0.4.0 (2019-06-05)

Bug Fixes

Features

  • support mochawesome4 and test mochawesome merge (7351bf1)
  • use mochawesome-merge v2.0.0 (35dbc4b)

0.3.1 (2019-06-04)

Bug Fixes

  • add #!/usr/bin/env node to cli runner (734f853)

0.3.0 (2019-06-04)

0.2.8 (2019-06-02)

0.2.7 (2019-06-02)

Build System

  • automated release pipeline via travis (c86592c)