nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 21:19:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
hookshot/docs/usage/room_configuration/jira_project.md
Andrew Ferrazzutti 505c083f5f
Add support for Jira version events (#534) 
- Support version created/updated/released events
- Look up project ID if missing when subscribing to version events
- Properly format version event notices
- Prioritize project URL over ID in debug strings
2022-10-21 09:24:35 -04:00

1.7 KiB
Raw Blame History

JIRA Project

This connection type connects a JIRA project to a room.

You can run commands to create and assign issues, and receive notifications when issues are created.

Setting up

To set up a connection to a JIRA project in a new room:

(NB you must have permission to bridge JIRA projects before you can use this command, see auth.)

  1. Create a new, unencrypted room. It can be public or private.
  2. Invite the bridge bot (e.g. @hookshot:example.com).
  3. Give the bridge bot moderator permissions or higher (power level 50) (or otherwise configure the room so the bot can edit room state).
  4. Send the command !hookshot jira project https://jira-instance/.../projects/PROJECTKEY/....
  5. If you have permission to bridge this repo, the bridge will respond with a confirmation message.

Managing connections

Send the command !hookshot jira list project to list all of a room's connections to JIRA projects.

Send the command !hookshot jira remove project <url> to remove a room's connection to a JIRA project at a given URL.

Configuration

This connection supports a few options which can be defined in the room state:

Option Description Allowed values Default
events Choose to include notifications for some event types Array of: Supported event types issue_created
commandPrefix Choose the prefix to use when sending commands to the bot A string, ideally starts with "!" !jira

Supported event types

This connection supports sending messages when the following actions happen on the project.

  • issue
    • issue_created
    • issue_updated
  • version
    • version_created
    • version_updated
    • version_released