obsdev-plugin-jira
v1.0.1
Published
A plugin for obsdev that uploads saved videos to JIRA ticket
Readme
obsdev-plugin-jira
Docs
A plugin for obsdev that uploads saved videos to JIRA ticket
Add by running obsdev plugins install obsdev-jira-plugin
Works by using regex to grab JIRA ticket ID (PROJ-1234) from video path. Branch names should follow this convention: feat/PROJ-1234 so video path has JIRA ticket ID. JIRA project key is expected to be all caps.
- Relevant JIRA API: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-rest-api-3-issue-issueidorkey-attachments-post
Required Environment Variables
- JIRA_DOMAIN
- Ex: companyname
- Do not include .atlassian.net
- JIRA_EMAIL
- JIRA_API_TOKEN
Usage
$ npm install -g obsdev-plugin-jira
$ obsdev-plugin-jira COMMAND
running command...
$ obsdev-plugin-jira (--version)
obsdev-plugin-jira/1.0.1 linux-x64 node-v24.8.0
$ obsdev-plugin-jira --help [COMMAND]
USAGE
$ obsdev-plugin-jira COMMAND
...Commands
obsdev-plugin-jira help [COMMAND]obsdev-plugin-jira pluginsobsdev-plugin-jira plugins add PLUGINobsdev-plugin-jira plugins:inspect PLUGIN...obsdev-plugin-jira plugins install PLUGINobsdev-plugin-jira plugins link PATHobsdev-plugin-jira plugins remove [PLUGIN]obsdev-plugin-jira plugins resetobsdev-plugin-jira plugins uninstall [PLUGIN]obsdev-plugin-jira plugins unlink [PLUGIN]obsdev-plugin-jira plugins update
obsdev-plugin-jira help [COMMAND]
Display help for obsdev-plugin-jira.
USAGE
$ obsdev-plugin-jira help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for obsdev-plugin-jira.See code: @oclif/plugin-help
obsdev-plugin-jira plugins
List installed plugins.
USAGE
$ obsdev-plugin-jira plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ obsdev-plugin-jira pluginsSee code: @oclif/plugin-plugins
obsdev-plugin-jira plugins add PLUGIN
Installs a plugin into obsdev-plugin-jira.
USAGE
$ obsdev-plugin-jira plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into obsdev-plugin-jira.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the OBSDEV_PLUGIN_JIRA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the OBSDEV_PLUGIN_JIRA_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ obsdev-plugin-jira plugins add
EXAMPLES
Install a plugin from npm registry.
$ obsdev-plugin-jira plugins add myplugin
Install a plugin from a github url.
$ obsdev-plugin-jira plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ obsdev-plugin-jira plugins add someuser/somepluginobsdev-plugin-jira plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ obsdev-plugin-jira plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ obsdev-plugin-jira plugins inspect mypluginSee code: @oclif/plugin-plugins
obsdev-plugin-jira plugins install PLUGIN
Installs a plugin into obsdev-plugin-jira.
USAGE
$ obsdev-plugin-jira plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into obsdev-plugin-jira.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the OBSDEV_PLUGIN_JIRA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the OBSDEV_PLUGIN_JIRA_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ obsdev-plugin-jira plugins add
EXAMPLES
Install a plugin from npm registry.
$ obsdev-plugin-jira plugins install myplugin
Install a plugin from a github url.
$ obsdev-plugin-jira plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ obsdev-plugin-jira plugins install someuser/somepluginSee code: @oclif/plugin-plugins
obsdev-plugin-jira plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ obsdev-plugin-jira plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ obsdev-plugin-jira plugins link mypluginSee code: @oclif/plugin-plugins
obsdev-plugin-jira plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ obsdev-plugin-jira plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ obsdev-plugin-jira plugins unlink
$ obsdev-plugin-jira plugins remove
EXAMPLES
$ obsdev-plugin-jira plugins remove mypluginobsdev-plugin-jira plugins reset
Remove all user-installed and linked plugins.
USAGE
$ obsdev-plugin-jira plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
obsdev-plugin-jira plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ obsdev-plugin-jira plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ obsdev-plugin-jira plugins unlink
$ obsdev-plugin-jira plugins remove
EXAMPLES
$ obsdev-plugin-jira plugins uninstall mypluginSee code: @oclif/plugin-plugins
obsdev-plugin-jira plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ obsdev-plugin-jira plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ obsdev-plugin-jira plugins unlink
$ obsdev-plugin-jira plugins remove
EXAMPLES
$ obsdev-plugin-jira plugins unlink mypluginobsdev-plugin-jira plugins update
Update installed plugins.
USAGE
$ obsdev-plugin-jira plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
