File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ <p align =" center " >
2+ <a href =" https://www.teamwork.com?ref=github " >
3+ <img src="https://www.teamwork.com/app/themes/teamwork-theme/dist/images/twork-slate.svg" width="139px" height="30px"/>
4+ </a >
5+ </p >
6+
7+ <h1 align =" center " >
8+ Teamwork Github Sync
9+ </h1 >
10+
11+ <p align =" center " >
12+ This action helps you to keep in sync your PRs and your Teamwork tasks
13+ </p >
14+
15+ ## Getting Started
16+
17+ ### Prerequisites
18+ Create the next environment vars in your repository:
19+ * ` TEAMWORK_URI ` : The URL of your installation (e.g.: https://yourcompany.teamwork.com )
20+ * ` TEAMWORK_API_TOKEN ` : The API token to authenticate the workflow
21+
22+ ### Installation
23+ Create a new file ` /.github/workflows/teamwork.yml `
24+
25+ ``` yaml
26+ name : teamwork
27+
28+ on : [pull_request]
29+
30+ jobs :
31+ teamwork-sync :
32+ runs-on : ubuntu-latest
33+ name : Teamwork Sync
34+ steps :
35+ - uses : miguelbemartin/teamwork-github@v1
36+ with :
37+ GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
38+ TEAMWORK_URI : ${{ secrets.TEAMWORK_URI }}
39+ TEAMWORK_API_TOKEN : ${{ secrets.TEAMWORK_API_TOKEN }}
40+ ` ` `
41+
42+ ## Usage
43+ When creating a new PR, write in the description of the PR the URL of the task and the action will automatically add a comment directly in the task.
44+
45+ ## Contributing
46+ * Open a PR: https://github.com/miguelbemartin/teamwork-github/pulls
47+ * Open an issue: https://github.com/miguelbemartin/teamwork-github/issues
48+
49+ ## Authors
50+ * **Miguel Ángel Martín** - [@miguelbemartin](https://twitter.com/miguelbemartin)
51+
52+ ## License
53+ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
You can’t perform that action at this time.
0 commit comments