https://github.com/reload/jira-security-issue
Lib for creating Jira security issues
https://github.com/reload/jira-security-issue
Last synced: about 1 year ago
JSON representation
Lib for creating Jira security issues
- Host: GitHub
- URL: https://github.com/reload/jira-security-issue
- Owner: reload
- License: mit
- Created: 2020-01-07T13:42:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T06:11:36.000Z (almost 2 years ago)
- Last Synced: 2025-04-25T21:41:39.962Z (over 1 year ago)
- Language: PHP
- Homepage: https://packagist.org/packages/reload/jira-security-issue
- Size: 127 KB
- Stars: 1
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reload Jira Security Issue
This is a small library that can create Jira issues. The main idea is
that it's simple to use and it'll not recreate an issue if the proper
keys are supplied.
Quick example:
``` php
$issue = new JiraSecurityIssue();
$issue->setTitle('Issue title')
->setBody('The main body');
$issue->setKeyLabel('some-unique-id');
echo $issue->ensure();
```
Configuration is set using environment variables, for ease of use in
CI systems.
- `JIRA_TOKEN`: A reference to the repo secret `JiraApiToken` (**REQUIRED**)
- `JIRA_HOST`: The endpoint for your Jira instance, e.g. https://foo.atlassian.net (**REQUIRED**)
- `JIRA_USER`: The ID of the Jira user which is associated with the 'JiraApiToken' secret, eg 'someuser@reload.dk' (**REQUIRED**)
- `JIRA_PROJECT`: The project key for the Jira project where issues should be created, eg `TEST` or `ABC`. (**REQUIRED** if not set in code)
- `JIRA_ISSUE_TYPE`: Type of issue to create, e.g. `Security`. Defaults to `Bug`. (*Optional*)
- `JIRA_PRIORITY`: The priority of issue to create, e.g. `Critical`. (*Optional*)
- `JIRA_WATCHERS`: Jira users to add as watchers to tickets. Separate
multiple watchers with comma (no spaces). (*Optional*)
- `JIRA_RESTRICTED_COMMENT_ROLE`: A comment with restricted visibility
to this role is posted with info about who was added as watchers to
the issue. Defaults to `Developers`. (*Optional*)