https://github.com/violinist-dev/violinist-messages

Template(s) for the pull requests that we send on updates.
https://github.com/violinist-dev/violinist-messages

composer composer-package php violinist

Last synced: 2 months ago
JSON representation

Template(s) for the pull requests that we send on updates.

• Host: GitHub
• URL: https://github.com/violinist-dev/violinist-messages
• Owner: violinist-dev
• Created: 2017-06-05T14:44:10.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-03-24T21:19:08.000Z (10 months ago)
• Last Synced: 2024-04-24T19:11:56.628Z (9 months ago)
• Topics: composer, composer-package, php, violinist
• Language: PHP
• Size: 44.9 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# violinist-messages

[![Test](https://github.com/violinist-dev/violinist-messages/actions/workflows/test.yml/badge.svg)](https://github.com/violinist-dev/violinist-messages/actions/workflows/test.yml)

[![Coverage Status](https://coveralls.io/repos/github/violinist-dev/violinist-messages/badge.svg?branch=master)](https://coveralls.io/github/violinist-dev/violinist-messages?branch=master)

Template(s) for the pull requests that we send on updates.

## Preview

To see a preview of how they look, head to [https://messages.violinist.io](https://messages.violinist.io)

## Templates

### Template for the pull request title

Currently it receives the following variables:

`name`: The name of the package to update.

`current_version`: The currently installed version of a package.

`new_version`: The version of the package the pull request is updating to.

`security_prefix`: Either the string `[SECURITY]` or an empty string, depending on whether the update was a security update or not.

### Template for the pull request body

Currently it receives the following variables:

`title`: The title rendered from the title template.

`changelog`: A markdown formatted changelog list, if available.

`custom_message`: A custom message, if configured.

`updated_list`: A list of the changed packages in the update.

`package`: The name of the package being updated.

`changed_files`: An array of the files changed in the update, if available.

`release_notes`: An array of links to release notes, if available.