Adds support for the Codecks issue tracker to PlasticSCM.
-
Download or build the CodecksExtension library.
-
Place the codecks folder (containing the plugin and its dependencies) in the extensions directory of the PlasticSCM installation. With the default installation on Windows, the path should look like this:
C:\Program Files\PlasticSCM5\client\extensions\codecks\CodecksExtension.dll
-
In the customextensions.conf file add the following line:
Codecks=extensions/codecks/CodecksExtension.dll
You might require admin permission to edit the file. The path is:
C:\Program Files\PlasticSCM5\client\customextensions.conf
-
Open the preferences in the PlasticSCM GUI and configure the Codecks extension with your personal settings.
Note that 'Account Name' is the subdomain of your organization used for the Codecks web frontend.
The process for developing and configuring PlasticSCM extensions is documented here.
Codecks provides the web API which is used by the extension to fetch task information and post status updates. As of February 2022, the API is in beta and not officially supported.
Requirements
- .NET Framework 4.0
- C# 7.0
- PlasticSCM 10.0.16.6505
Of course the plugin should work in other (if not all) versions of PlasticSCM, but this specific one is known to work. The beta GUI (PlasticX) of the same version is also supported internally. At the time of writing, PlasticX allows creating a new branch from a task, but doesn't show task info anywhere else.
The codecks extension depends on libraries provided by PlasticSCM (e.g. issuetrackerinterface.dll). In theory, these dependencies should be provided by the host process (the Plastic GUI), however, the new beta GUI PlasticX does not load the utils.dll. For this reason, it was decided to simply copy-paste the libraries during development and deploy them right next to the extension. See the 'Libraries' folder in the repository.
The project solution includes a "Start Host" configuration which builds the extension and copies it directly to the default PlasticSCM installation path and also launch the GUI client for interactive testing and debugging. Most likely, your IDE will need to be started with admin permissions for this to work.
Unable to copy file x to y. Access to the path y is denied.
Try to start your IDE with admin permissions.
My PlasticSCM installation path is different.
Change the output path in the project configuration, or, add a CodecksExtension.csproj.user file and overwrite the outputPath property locally.
Runtime errors when loading the extension.
Unless the issue is caused by a specific programming error or incompatible API changes, it's likely that certain dependencies haven't been loaded correctly. Ensure that all required libraries are copied next to the extension DLL. Maybe the version of one of the development libraries no longer matches PlasticSCM after an update. Try to upgrade the dev lib with a newer version. If specific types fail to load, Plastic may have changed their .NET target framework version.
If you'd like to contribute or have any trouble using the extension, open a new issue to discuss it or message me on Discord: Chris Yarbrough#8887