Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GitLab Issue Lookup is supported by Workbench.

Not sure we actually need to document anything here. It Just works when you select GitLab as your Work Item ManagementM system.

Thoughts, Larry Pieniazek (Unlicensed)?

...

Table of Contents

There are a few simple steps to get GitLab Issue Lookup working in MettleCI Workbench…

Register your MettleCI Workbench public SSH key with GitLab

Ensure your the public SSH key from the DataStage Engine running MettleCI Workbench has been registered with your GitLab instance.

Register MettleCI Workbench as an GitLab Application

Register your Engine’s MettleCI Workbench instance as an authorised Application in GitLab.

Note

Note that you’ll unavoidably need to revisit step 2. Follow the steps below carefully!

  1. Name your application logically so GitLab administrators understand its function. Something like MettleCI Workbench {EngineName} might be a good example.

  2. For your Redirect URI start by enter a URL following the example given below (substituting your DataStage Engine URI to appropriate values)

    • http://your-engine.your-org.com:8080/api/auth/delegated/2

  3. Ensure the following checkboxes are selected…

  • Trusted

  • Confidential

  • Expire access tokens

  • Scopes

    • API

    • openid

For example…

...

Once complete you’ll be presented with information about your registered Application.

...

You should keep this window open, to support you during the next configuration step, as…

  • You’ll need to copy the Application ID and Secret values, and

  • You may need to edit the Callback URL, depending upon what Workbench tells you

Configure your GitLab Issue Lookup in Workbench

You’ll need to register your GitLab instance as an Issue lookup source in MettleCI Workbench.

  1. Select Issue Management from the Profile icon in the top-right of the Workbench window.

    Image Added

  2. On the resulting page click the [+] icon, in the top-right, to add a new issue management system.

  3. Select GitLab as your Issue Management Type, then Next.

  4. On the next page enter

    1. A Name that will help you uniquely identify your GitLab instance,

    2. The URL of your GitLab instance

    3. The Application ID and Secret values you were presented by GitLab in the previous configuration step

      Image Added
  5. Once complete, click Next. You’ll be presented with your list of registered Issue Management Systems including your newly-defined GitLab instance

    Image Added
Note

At this point you must check that the Callback URL presented on this page matches the Callback URL shown against your registered Application in GitLab.

The value presented by Workbench takes precedence, so if the values don’t match return to GitLab and Edit the Application definition to update the Callback URL with the value presented by Workbench.


Associate it with a MettleCI project

Test your GitLab Issue Lookup is working by Workbench

Now test your GitLab Issue Lookup is working in MettleCI Workbench

by navigating to the Commit/Check-in page of the

Image Added

Image Added

See Also

Configuring MettleCI Workbench SSH Authentication to GitLab