reload/jira-security-issue

Create Jira issues if it doesn't exist

v2.0.2 2024-09-24 06:10 UTC

Requires

• php: >=8.2.0
• lesstif/php-jira-rest-client: ^5
• webignition/symfony-console-typed-input: ^0.6

Requires (Dev)

• appocular/coding-standard: ^2.0
• jangregor/phpstan-prophecy: ^1.0
• phpspec/prophecy: ^1.15
• phpspec/prophecy-phpunit: ^2.0
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^11.0
• sempro/phpunit-pretty-print: ^1.2
• symfony/console: ^5.0

MIT

README

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:

        $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 '[e-mail]' (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)