Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
teamwork

GitHub Action

Teamwork GitHub Sync

v1.2.0

Teamwork GitHub Sync

teamwork

Teamwork GitHub Sync

This action helps you to sync your PRs with tasks in Teamwork to streamline team collaboration and your development workflows

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Teamwork GitHub Sync

uses: Teamwork/[email protected]

Learn more about this action in Teamwork/github-sync

Choose a version

Teamwork GitHub Sync

This action helps you to sync your PRs with tasks in Teamwork to streamline team collaboration and your development workflows.

Linter

Getting Started

Prerequisites

Create the next environment vars in your repository:

Please Note: The Teamwork account associated with this API key is the account which these comments will be created under. If this user does not have permission to access the project, this action will be ignored.

GITHUB_TOKEN doesn't need to be setup in the repository, this var is always available during the workflows execution.

Installation

Create a new file /.github/workflows/teamwork.yml with the following:

name: teamwork

on:
  pull_request:
    types: [opened, closed]
  pull_request_review:
    types: [submitted]

jobs:
  teamwork-sync:
    runs-on: ubuntu-latest
    name: Teamwork Sync
    steps:
      - uses: teamwork/github-sync@master
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          TEAMWORK_URI: ${{ secrets.TEAMWORK_URI }}
          TEAMWORK_API_TOKEN: ${{ secrets.TEAMWORK_API_TOKEN }}
          AUTOMATIC_TAGGING: false

Usage

When creating a new PR, write in the description of the PR the URL of the task. The action will automatically add a comment in the task.

Please note, the comment will be created in Teamwork under the account you have attached to this action. If the API key of the user you are using does not have permissions to access certain projects, the comment will not be created.

GitHub pr comment

Teamwork pr comment

Tags are added automatically on the task if you are have the option AUTOMATIC_TAGGING set to true and the tag exists in you targeting project:

  • A new PR is open: tag PR Open
  • A PR is approved: tag PR Approved added
  • A PR is merged: tags PR Open and PR Approved removed, tag PR merged added
  • A PR is closed: tags PR Open and PR Approved removed

Contributing

License

This project is licensed under the MIT License - see the LICENSE file for details