Skip to content

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
mediabounds committed Jan 18, 2023
0 parents commit 2887f3c
Show file tree
Hide file tree
Showing 34 changed files with 6,777 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module.exports = {
root: true,
parser: '@typescript-eslint/parser',
parserOptions: {
tsconfigRootDir: __dirname,
project: ['./tsconfig.json'],
},
plugins: ['@typescript-eslint', 'eslint-plugin-tsdoc'],
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:@typescript-eslint/recommended-requiring-type-checking',
],
rules: {
"@typescript-eslint/no-unused-vars": ["error", { "args": "none" }],
"tsdoc/syntax": "warn"
}
};
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/build
node_modules
*.streamDeckPlugin
Empty file added CHANGELOG.md
Empty file.
20 changes: 20 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# The MIT License (MIT)

Copyright (c) 2023 Daniel Pfeiffer

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Stream Deck Jira Plugin
A Stream Deck plugin for viewing the number of Jira issues matching a JQL query (i.e. the number of new issues or issues waiting for your feedback).

## Features
* Allows for multiple actions to be defined with different JQL queries
* Button icon shows the count of issues matching the query
* The button opens each matching issue in a separate browser window

### Limitations
* The plugin uses the action icon for showing the number of issues matching a query; customizing the action icon will prevent the badge from being shown.

## Installation
### Plugin Store
_Coming soon..._

### Manual installation
1. Download the latest release from <https://github.com/mediabounds/streamdeck-jira/releases>.
2. Go to your download folder and open `com.mediabounds.streamdeck.jira.streamDeckPlugin`.

## Configuration
### Global settings
* **Domain** -- the product URL for your Jira organization (i.e. `organization.atlassian.net`)
* **Email** -- the email address for your Atlassian account
* **API Token** -- an API token for your account which can be created at <https://id.atlassian.com/manage-profile/security/api-tokens>.

### JQL Result action
In addition to the **Global settings**, the JQL Result action also requires:
* **JQL** -- a query for filtering a list of issues.

Optionally, you may also customize how the icon is badged with the number of issues matching the JQL query.

## License
The plugin is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
found at <https://github.com/mediabounds/streamdeck-jira/blob/main/LICENSE.md>.
Loading

0 comments on commit 2887f3c

Please sign in to comment.