chrisyarbrough / codecksplasticintegration Goto Github PK

At the time of writing, the Codecks API is in beta and documentation is lacking. This makes it difficult to craft well-designed queries, since the underlying schema is not known. It would be super helpful to know more about how the API works internally, which properties are defined in what sort of hierarchy, etc.

Current resources:

• https://manual.codecks.io/api/
• https://gist.github.com/danielberndt/eb59230c4ac5c2fd7edaa27dfb2b2e89
• Using the Chrome DevTools to investigate web requests in the live web app
• Using Postman to try out various API calls

The Codecks roadmap lists Q1 2022 as an ETA for improved API Docs :
https://open.codecks.io/codecks-roadmap/decks/2567-roadmap-major-features/card/1awz-api-docs

Looking forward to it! :)

If anyone has additional information, regarding any API calls, release dates, etc, please let me know.

As the title says, whenever I create a branch and use the "From Task" tab, it displays all issues, regardless of status.
I assume this is unintended behaviour, as done tasks (in Codecks) should not have a branch assignable to them in order to preserve proper workflow.

At first glance it seemed correct to only show cards which have not been started yet in the "Create Branch" view. However, multiple users reported being confused that their card didn't show up after they already set its status to "started" via the Codecks web app.

It's probably better to show cards including started ones and let users use the filtering options. Also, I noticed that the tasks list returned by Codecks is already ordered so that more recent cards show up at the top of the list, which is convenient even without using filters.

Currently, when creating a new branch, non-archived cards from all decks and projects are shown. In larger organizations this might cause the list to be extremely long and potentially slow to fetch or filter. Also it could simply be overwhelming in case users want to manually browse available tasks.

A good way to reduce the number of shown cards would be to associate a repository with a specific Codecks project. The project would be optionally defined in the user preferences by its name.

This method is not implemented and I haven't explored how Plastic calls this or what it is supposed to be used for. The docs do mentiond it, but still hard to get the idea without an example.

As a first test it would probably help to attach the debugger, set a breakpoint in the method and then going through a few interactions in the Plastic GUI.

This method is called by Plastic to allow the issue tracker to implement progress tracking or similar notifications.

With Codecks, there are several options how this could be used:

• Add a comment to the card simply stating that a checkin was performed.
• Include meta info (changeset comment, time, etc).
• In task-on-changeset mode: set the card status to review or done.
• Any feature should be toggled by a user pref because it could be very intrusive

Other ideas welcome!

The integration seems to work fine in the current version of Unity DevOps Version Control (previously PlasticSCM), but there is some behaviour that seems unintended.

My setup:
Logged into Unity Version Control with my Unity ID, with email address A.
Codecks account uses email address B. I entered this into the Preferences > Issue Trackers window inside UVCS/Plastic according to the image shown at point 4 of Getting Started in the integration readme.

The integration seems to attempt to fetch the task data from Codecks using email address A, instead of email address B. It then returns an error, stating "Failed to find user by mail: [email address A]". I believe that the integration should not be using email address A here, but instead should use email address B as entered in the Preferences > Issue Trackers window.

My colleague uses only 1 email address for all of this, and for him the integration works as expected.

Thanks in advance!