Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.
Justin Gasper edited this page Aug 15, 2018 · 19 revisions

How to use Topcoder-X

This document will describe how to use Topcoder-X as a copilot.

Topcoder-X Goal

Topcoder-X is an application that allows a copilot or Topcoder customer to manage work directly through Gitlab or Github. When an issue is created in a Gitlab or Github project set up in Topcoder-X, Topcoder-X will create a Topcoder challenge to mirror the Gitlab or Github issue, and it will ensure that the challenge has the correct prize, copilot, assignee, description, and title.

As the Gitlab or Github issue is updated, Topcoder-X will ensure that the Topcoder challenge associated with the issue is updated appropriately. When the Gitlab or Github issue is closed, Topcoder-X will activate and close the Topcoder challenge, ensuring that the members (submitter and copilot) get paid as expected.

General flow

Topcoder-X monitors Gitlab and Github repositories, looking at issues created. Gitlab and Github repositories will need to be configured with a webhook callback for Topcoder-X so that Topcoder-X is "aware" of changes made to issues on a repo. Topcoder-X can create this webhook for you.

When Topcoder-X performs specific actions to the Topcoder challenge that is associated with a Github / Gitlab ticket, Topcoder-X will create comments on the issue in Github / Gitlab explaining the update and where to find the Topcoder challenge.

Setup

When you first login to Topcoder-X, you will see a screen like this:

Link Github and Gitlab

Topcoder-X first needs to know about your Github and Gitlab username. It will use this to map your Github and Gitlab user to your Topcoder handle, as well as make comments to issues on your behalf on Gitlab and Github.

  • Click your username in the upper right
  • Select Settings

You will now see a screen where Github and Gitlab can be setup:

Click Setup for both Gitlab and Github and authorise Topcoder-X to have access to your repo.

Once done, you should see checkmarks next to both Gitlab and Github.

Clone this wiki locally