Plastic SCM plugin for Polarion v3.17.1 or lower
================================================

This extension allows to link Plastic SCM revisions (changesets) to Polarion
workitems.

How to install the extension
----------------------------
1. Stop Polarion server
2. Copy the directory com.codicesoftware.platform.repository.external.plasticscm
to the Polarion extensions folder ([INSTALL]/polarion/extensions)
3. Start Polarion server

How to uninstall the extension
------------------------------
1. Stop Polarion server
2. Remove the directory com.codicesoftware.platform.repository.external.plasticscm
from the Polarion extensions folder ([INSTALL]/polarion/extensions)
3. Start Polarion server

UPGRADE NOTES: Remember to upgrade the Polarion plugin every time the Plastic SCM
client installation is upgraded. (Each new release, the Plastic SCM client's command
line output may change. This output is parsed by the underlying Java API of the 
Polarion plugin, and that's why it is safer to upgrade the plugin each time you upgrade
your Plastic SCM client).

Configuration
-------------
1. Go to Administration -> repositories -> Add new repository
2. Select plasticscm from the combo
3. Example configuration:

ID=my_id
Branch=/main
Name=myrepo
Repository Name=myrepo
Server=myserver:8087
View Location Diff Url=http://mywebuisite/codice/ViewChanges?changeset=$revision$
View Location Url=http://mywebuisite/codice/ItemDetails/$location$&changeset=$revision$
View Ur=http://mywebuisite/myrepo/ViewChanges?changeset=$revision$<not used>

Use cases
---------
1. Link a revision to a workitem:
* Create a plastic repository in polarion, and configure it
* Open a workitem in Polarion
* Scroll down to linked revisions
* Add a plastic revision (changeset)

2. Link a workitem via checkin comment:
Polarion can recognize Work Item IDs in Plastic commit messages, so you can
automatically create a link between a Work Item and a revision simply by
including the ID in the commit message. If a commit resolves more than one Work
Item, you can include multiple IDs in the commit message and revision links will
be created for all mentioned items.
Example:

$ cm ci -c="Resolves DP-309 for Milestone 14"

This action will link the workitem DP-309 to the recently created changeset.