https://github.com/chrisyarbrough/codecksplasticintegration
PlasticSCM/Unity DevOps extension to use the Codecks issue tracker
https://github.com/chrisyarbrough/codecksplasticintegration
csharp devops game-development gamedev issue-tracker plasticscm unity version-control
Last synced: 9 months ago
JSON representation
PlasticSCM/Unity DevOps extension to use the Codecks issue tracker
- Host: GitHub
- URL: https://github.com/chrisyarbrough/codecksplasticintegration
- Owner: chrisyarbrough
- License: mit
- Created: 2022-02-05T21:02:39.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-27T18:58:29.000Z (about 1 year ago)
- Last Synced: 2025-04-05T14:41:54.918Z (10 months ago)
- Topics: csharp, devops, game-development, gamedev, issue-tracker, plasticscm, unity, version-control
- Language: C#
- Homepage:
- Size: 927 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Codecks Integration for PlasticSCM / Unity DevOps #
Adds support for the [Codecks](https://www.codecks.io/) issue tracker to [PlasticSCM](https://www.plasticscm.com/).
- Create new branch from task (Codecks card)
- Mark card as started when branch is created
- Branch prefix is configurable in the extension settings
- Open task externally (on Codecks website)
> _PlasticSCM_ was acquired by Unity in 2020 and is now called _Unity DevOps Version Control_.
> The features, including this extension, work mostly the same though.
For details about what a task and issue tracking extension can do, see
this [guide](https://docs.plasticscm.com/extensions/plastic-scm-version-control-task-and-issue-tracking-guide).
## Getting Started - User Setup
1) Install Unity DevOps Version Control (PlasticSCM).
The client can be downloaded [here](https://www.plasticscm.com/download).
2) [Download](https://github.com/chrisyarbrough/CodecksPlasticIntegration/releases)
or build the CodecksExtension library (zip file with DLLs).
3) Place the `codecks` folder (containing the plugin and its dependencies)
in the extensions directory of the PlasticSCM installation.
With the default installation, the path should look like this:
- Windows: `C:\Program Files\PlasticSCM5\client\extensions\codecks\CodecksExtension.dll`
- macOS: `/Applications/PlasticSCM.app/Contents/extensions/codecks/CodecksExtension.dll`
4) Find the file `customextensions.conf`:
- Windows: `C:\Program Files\PlasticSCM5\client\customextensions.conf`
- macOS: `/Applications/PlasticSCM.app/Contents/MacOS/customextensions.conf`
Add the following line to the file:
> Codecks=extensions/codecks/CodecksExtension.dll
You may need admin permissions to edit this file.
5) 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.
| Property | Required | Description |
|----------------|----------|--------------------------------------------------------------------------------------------------------------------------|
| E-Mail | yes | The mail of your Codecks user. |
| Password | yes | The password for the Codecks user. Used to fetch an authentication token. |
| Branch Prefix | | When creating a branch from a task, the Codecks card id is always included. Use this property to add an optional prefix. |
| Account Name | yes | The subdomain of your Codecks organization. |
| Project Filter | | The name of a Codecks project to use as a filter or empty if all projects should be considered. |
| Deck Filter | | The title of a deck to use as a filter or empty if all decks should be considered. |
## Query Editing (Advanced)
In the Codecks extension directory, there's directory with json queries.
These queries are used to fetch cards from the Codecks API.
In case the API changes before this extension is updates, or if you have special requirements,
you might be able to adjust these queries for your use-case.
---
## Developer Setup
### Building from Source
**Prerequisites**
- .NET 7.0 SDK
- PlasticSCM (tested with 11.0.16.9080)
Of course the plugin should work in other (if not all) versions of PlasticSCM, but this specific one is known to work.
The codecks extension depends on libraries provided by the PlasticSCM host, see the _Libraries_ directory.
The project solution includes a "Start Host" configuration which builds the extension and copies it directly to
the default PlasticSCM installation path and also launches the GUI client for interactive testing and debugging.
To allow this on your machine, either set the permissions of the
PlasticSCM/extensions/codecks directory to allow writing.
Or start your IDE with elevated privileges.
(at your own risk)
For example on macOS:
```zsh
EXT_DIR=/Applications/PlasticSCM.app/Contents/extensions/codecks/
sudo mkdir -p $EXT_DIR
sudo chown -R username $EXT_DIR
```
On macOS, you might also need to go to Settings -> Privacy & Security -> App Management -> Allow your IDE to update
other applications
On Windows, right-click the folder, select _properties_ and allow 'write' permissions for your user.
## Testing
To run the regular unit tests:
```bash
dotnet test
```
To run the (end-to-end) _CodecksServiceTests_ configure your dotnet user secrets like so:
```bash
dotnet user-secrets set
```
| Key | Value Description |
|------------------|---------------------------------------------------------------------|
| Codecks:Email | Email address of your Codecks account. |
| Codecks:Password | Password associated with the Codecks email. |
| Codecks:Account | Account name of your Codecks organization (not your personal name). |
### Change Output Directory
If your PlasticSCM client is installed in a different location,
create the file `User.Build.props` next to the CodecksExtension.csproj file.
Then add this content with your custom path:
```xml
/Applications/PlasticSCM.app/Contents/extensions/codecks/
C:\Program Files\PlasticSCM5\client\extensions\codecks\
```
This file is ignored by git.
## Additional Resources
The process for developing and configuring PlasticSCM extensions is documented
[here](https://www.plasticscm.com/documentation/extensions/plastic-scm-version-control-task-and-issue-tracking-guide#WritingPlasticSCMcustomextensions).
Codecks provides the [web API](https://manual.codecks.io/api/)
which is used by the extension to fetch task information and post status updates.
As of August 2023, the API is still in beta, but it has been very stable since 2022.
## Contributing
If you'd like to contribute or have any trouble using the extension, open a new issue to discuss it.
If you already have a working fix in place, please open a Pull Request, thank you!