/forward

Enable emails on CI/CD pipelines

Primary LanguagePHPMIT LicenseMIT

Forward

Easily forward report or artefact from your CI/CD to you email

StyleCI Build Status codecov Codacy Badge

Forward your artefacts or your reports via email from your CI/CD pipeline. With javanile/forward microservice you could send by email the output of your favourite pipeline platforms like: GitLab, BitBucket, Travis-CI, Jenkins, etc...

Get Started

Deploy

Installation

  1. Place javanile/forward inside any PHP server with virtual host over public/ directory.
  2. Copy config.sample.php to config.php and set your mail server settings.
  3. Create a pair with Hash and Token based on secret passphrase and recipient email

Hash and Token

Sinply create an Hash to blind your secret passphrase to hosting maintainers

$ php bin/hash <my-secret-passphrase>
# b3598964c6788457cf7108dcbbb30da67d9121d74501f990b0a4476154768ba6 
# (copy & paste into config.php file)

Next create a Token ready to grant email forwarding to the recipient

$ php bin/token <recipient-email> <my-secret-passphrase>
# b3598964c6788457cf7108dcbbb30da67d9121d74501f990b0a4476154768ba6 
# (copy & paste into cURL command)

Send first email

When finish installation you try to send email via CURL

curl -L "https://forwarding.myserver.dev" \
     -H "To: admin@admin.dev" \
     -H "Token: b3598964c6788457cf7108dcbbb30da67d9121d74501f990b0a4476154768ba6" \
     -H "Subject: Nightly Release" \
     -F "release=@release-nightly.zip"

Examples

GitLab sofware release

GitLab code quality report

BitBucket sofware release

Travis-CI code quality report

Travis-CI code quality report

Jenkins code quality report

Jenkins code quality report