action-youtrack-sync

Action for syncing with YouTrack boards.

Works by doing the following:

1. Create your desired ticket(s).

2. Write your tickets on the pull request description.

3. See them turn into links towards the linked YouTrack.

4. A comment with the status changed and the synced tickets will be added.

5. Your pull request will be labeled with the specified fields of the ticket. (priority, type, project...)

6. Finally your ticket(s) is moved to the specified column.

Goes well in combination with action-youtrack-move.

Usage

Basic example with default options for a project where tickets look like BB-123.

name: YouTrack Issue Sync

on:
  - pull_request

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: bloobirds-it/[email protected]
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          yt-url: ${{ secrets.YOUTRACK_URL }}
          yt-token: ${{ secrets.YOUTRACK_TOKEN }}
          yt-project-id: "BB"

Now when you open a pull request make sure to write your tickets in the description so the action can sync them.

Inputs

github-token

Usual GitHub token, one is available by default as ${{ secrets.GITHUB_TOKEN }}.

• Required: Yes

yt-url

Base URL of your YouTrack instance.

• Required: Yes
• Default: "https://my-yt.myjetbrains.com/youtrack"

yt-token

YouTrack generated permanent token. For more info on how to generate.

• Required: Yes

yt-project-id

Issue ID prefix used in the projects. Basically the letters before your tickets.

• Required: Yes

yt-column-field

Name of the field which represents the ticket state.

• Required: No
• Default: "Stage"

yt-column-triggers

From which columns is the card allowed move to the target.

• Required: No
• Default: "To Do, To Fix, In Progress"

yt-column-target

To which column should the related tickets be moved.

• Required: No
• Default: "PR Open"

yt-label-fields

Which fields used to label the pull request. If for example you have a ticket with the fields {Type: Feature, Priority: Low}, the action will label the PR with type/feature and priority/low.

• Required: No
• Default: "Type, Priority"

yt-label-prefix

A prefix to append to the label that the action generates. If you set it for example to @yt/, the generated labels will look like @yt/type/feature.

• Required: No

License

The scripts and documentation in this project are released under the MIT License