Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 3.93 KB

README.md

File metadata and controls

60 lines (41 loc) · 3.93 KB
Raw

Favro - Plastic SCM integration

Build Status

Important

This project is still under development. Some functionalities may not work as expected.

Installation

There are two options to install the plugin in your local client. You can build the plugin library from the source code or you can download an already built library from the distribution folder. You also need Microsoft .NET Framework 4.7 runtime installed in your machine.

Build from source

Prerequisites:

Steps:

  1. Clone this repository into your local computer.
  2. Open the solution FavroPlasticExtension.sln
  3. Select the Release configuration
  4. Build the FavroPlasticExtension project
  5. Copy the FavroPlasticExtension.dll library to your Plastic SCM extensions folder. Usually located at C:\Program Files\PlasticSCM5\client\extensions. There you will need to create a new folder for this extension library named favro and copy the dll inside.
  6. Modify the customextensions.conf file adding the following line at the end Favro=extensions/favro/FavroPlasticExtension.dll

If you want to debug the plugin:

  1. Clone this repository into your local computer.
  2. Open the solution FavroPlasticExtension.sln as Administrator
  3. Open the project FavroPlasticExtension properties page and go to Debug tab to set the "Start external program:" option to the path of the plastic client executable (usually C:\Program Files\PlasticSCM5\client\plastic.exe)
  4. Select the Debug configuration
  5. Select the project FavroPlasticExtension as startup project
  6. Launch the Visual Studio debugger (F5), if your Plastic install directory is the default (C:\Program Files\PlasticSCM5) it will work without problems

Plugin configuration

Once installed, we will be able to configure the plugin using the Preferences window of the Plastic SCM client. Once there, go to the Issue Tracker section. An option to select Favro as issue tracker will be available.

The parameters that you will need to configure are:

  • User: the email used to log into Favro
  • Password: Your Favro password or API Key
  • Prefix: Prefix used to build the name of the branches
  • Suffix: Suffix used to build the name of the branches
  • Doing column name: setup workflow of tasks specifying the name of the Doing column in Favro boards (on going tasks)
  • Organization: The hash identifier of your organization in the Favro page. You can know this ID easly by looking at the Favro URL once logged in. The URL will be something similar to: https://favro.com/organization/<organization_id>/<collection_id>. The organization_id part is the one needed.
  • CollectionId: The identifier of a Favro Collection, used to filter cards for a specific project. You can know this ID easly by looking at the Favro URL once logged in. The URL will be something similar to: https://favro.com/organization/<organization_id>/<collection_id>. The collection_id part is the one needed.
  • WidgetCommonId: The identifier of a Favro Widget (a Board or a Baglog), used to filter cards for a specific project even more. You can know this ID from the Board/Backlog options menu "(...)" -> "Link to this board/backlog". The URL will be something similar to: https://favro.com/widget/<organization_id>/<widget_common_id>. The widget_common_id part is the one needed.

References

The code of this project was developed using the following documentation