becklyn/deploy-message-generator

A symfony CLI tool that automatically produces beautiful deployment messages.

2.2.0 2022-04-29 12:50 UTC

Requires

• php: >=7.4
• ext-json: *
• symfony/config: ^5.4.7 || ^v6.0.7
• symfony/console: ^v5.4.7 || ^v6.0.7
• symfony/dotenv: ^v5.4.5 || ^v6.0.5
• symfony/http-client: ^v5.4.7 || ^v6.0.7
• symfony/notifier: ^v5.4.6 || ^v6.0.6
• symfony/process: ^v5.4.7 || ^v6.0.7
• symfony/runtime: ^v5.4.7 || ^v6.0.7
• symfony/slack-notifier: ^v5.4.3 || ^v6.0.3
• symfony/string: ^v5.4.3 || ^v6.0.3
• symfony/yaml: ^v5.4.3 || ^v6.0.3

Requires (Dev)

• roave/security-advisories: dev-latest
• symfony/phpunit-bridge: ^v5.4.7 || ^v6.0.7
• symfony/var-dumper: ^v5.4.6 || ^v6.0.6

BSD-3-Clause

README

A generator that produces beautiful deploy messages and integrates nicely with Slack and Jira.

Installation

composer global require becklyn/deploy-message-generator

Required Environment Variables

These variables can also be defined by placing .deploy-message-generator.env in your $Home (or %USERPROFILE% for Windows) directory.

Variable Name	Purpose
SLACK_ACCESS_TOKEN	Token needed to send messages to Slack
SLACK_USER_MENTION	The slack user mention to „sign“ a deployment
JIRA_USER_EMAIL	The email address of the user used to lookup the ticket information
JIRA_ACCESS_TOKEN	The access token for the JIRA_USER_EMAIL (https://id.atlassian.com/manage-profile/security/api-tokens)

Configuration

The generator is configured using the .deploy-message-generator.yaml file. Check the examples dir to learn more.