https://github.com/becklyn/deploy-message-generator
A symfony CLI tool that automatically produces beautiful deployment messages.
https://github.com/becklyn/deploy-message-generator
Last synced: 3 months ago
JSON representation
A symfony CLI tool that automatically produces beautiful deployment messages.
- Host: GitHub
- URL: https://github.com/becklyn/deploy-message-generator
- Owner: Becklyn
- License: bsd-3-clause
- Created: 2021-09-08T09:56:43.000Z (over 3 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-01-25T13:55:31.000Z (over 1 year ago)
- Last Synced: 2025-01-14T03:13:57.506Z (4 months ago)
- Language: PHP
- Size: 72.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Deploy message Generator
========================
A generator that produces beautiful deploy messages and integrates nicely with Slack and Jira.
Installation
------------
```bash
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.