Skip to content

A simple command line interface for sending notifications to RocketChat

License

Notifications You must be signed in to change notification settings

krakowski/rocket

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a small application designed for sending notifications to RocketChat. It was developed with the idea of sending notifications from CI pipelines to channels.

🔧   Installation

The binary is available for Linux, macOS and Windows from the GitHub Releases page.

💡   Example

First a ".rocket" folder must be created in the project directory.

mkdir .rocket

In the next step a template for the notification is created in the folder just created.

cat << EOF > .rocket/my-template.yml
channel: '#my-channel'
text: 'Hello from {{.Env.SENDER}}'
EOF

Since the YAML file is processed with the template package, as in this example, environment variables can be used. The created template can now be used to send a notification.

ROCKET_HOST=https://rocketchat.com ROCKET_USER=myuser ROCKET_PASS=mypass SENDER=Rocket rocket notify my-template

The environment variables can of course also be set in advance. This includes variables set in CI Pipelines.

📐   Configuration Options

The rocket tool accepts the following arguments.

Name Type Required Description
TEMPLATE string The name of the template to be used
--directory, -d string The directory in which to search for templates (default: .rocket)

Additionally some options are configured via environment variables.

Name Type Required Description
ROCKET_HOST string The URL of the RocketChat server to connect to
ROCKET_USER string The RocketChat user's username
ROCKET_PASS string The RocketChat user's password

ROCKET_USER and ROCKET_PASS are not required, since they are interactively queried from the console when not available.

Please refer to the RocketChat documentation to find out which fields can be set in the template file(s).

📜   License

This project is licensed under the GNU GPLv3 License - see the LICENSE file for details.

About

A simple command line interface for sending notifications to RocketChat

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages