Skip to content

Commit

Permalink
Text changes (#1)
Browse files Browse the repository at this point in the history
* Update ReadMe

I have added two sections relating to permissions and one for teh over text. I think this should be enough for now.

-H

* Update README.md

* Update README.md
  • Loading branch information
holly-mcgill authored Aug 25, 2020
1 parent 0249494 commit 6e46a68
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,17 @@
</h1>

<p align="center">
This action helps you to keep in sync your PRs with your Teamwork tasks.
This action helps you to sync your PRs with tasks in Teamwork to streamline team collaboration and your development workflows.
</p>

## Getting Started

### Prerequisites
Create the next environment vars in your repository:
* `TEAMWORK_URI`: The URL of your installation (e.g.: https://yourcompany.teamwork.com)
* `TEAMWORK_API_TOKEN`: The API token to authenticate the workflow
* `TEAMWORK_API_TOKEN`: The API token to authenticate the workflow. Follow [this guide](https://developer.teamwork.com/guides/api-key-url/) to find your URL and API key.

**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.

Expand Down Expand Up @@ -50,7 +52,9 @@ jobs:
```
## 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.
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](./.github/assets/github_pr_comment.png)
Expand Down

0 comments on commit 6e46a68

Please sign in to comment.