README.md in danger-yajp-0.0.2 vs README.md in danger-yajp-0.1.0
- old
+ new
@@ -1,8 +1,10 @@
# Yet Another Jira Plugin
-[](LICENSE)
+[](LICENSE)
+[](https://rubygems.org/gems/danger-yajp)
+[](https://libraries.io/rubygems/danger-yajp)
Yet Another Jira Plugin (in short: yajp) is a [Danger](https://danger.systems/ruby/) plugin that provides methods to easily find and manipulate issues from within the Dangerfile. The major difference with the existing Jira plugins is the ability to transition and update issues with the same feeling as manipulating PR data from Danger. This plugin was build in the same mind as Danger, meaning that you will find methods to easily manipulate Jira data, but no predefined warning and/or message.
Inspired by [danger-jira](https://github.com/RestlessThinker/danger-jira), from which I borrowed the issue search, and by [danger-jira_sync](https://github.com/roverdotcom/danger-jira_sync) for their usage of the awesome [jira-ruby](https://github.com/sumoheavy/jira-ruby) gem.
@@ -54,9 +56,17 @@
```
The `transition` method only takes fields available in the transition screen. Use the `split_transition_fields` method to separate the fields available in the transition screen, or use the `transition_and_update` method to transition and update issues (and automatically dispatch the fields to the correct action).
> Transition IDs can be found in Jira under Project Workflow > Edit Workflow in Text Mode.
+
+### Reference the PR as a remote link
+
+yajp can reference the PR as a remote link on Jira. It will use the icon of GitLab or Github depending on what you use. The remote link will use the URL of the PR as a `globalId` to not create duplicates. Optionnaly, you can specify the relationship with the issue (default is `relates to`), and the status, either as an object (eg. `{ "resolved": true, "icon": {...} }`) or as a boolean that will set the value of the property `resolved`. By default, no status is sent.
+
+```rb
+jira.pr_as_remotelink(issue, false)
+```
### Issue URL
Use `issue_link` to retrieve the browse URL of the Jira issue.
\ No newline at end of file