Skip to content

Commit 5264940

Browse files
committed
typos in docs
1 parent 385529c commit 5264940

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@ This action integrates asana with github.
1212

1313
### `asana-pat`
1414

15-
**Required** Your public access token of asana, you can generate one [here](https://app.asana.com/0/developer-console).
15+
**Required** Your public access token for asana, you can generate one [here](https://app.asana.com/0/developer-console).
16+
17+
### `action`
18+
19+
**Required** The action to be performed assert-link|add-comment|remove-comment|move-section
1620

1721
### `github-token`
1822

19-
**Required** A github auth token (used to set statuses)
23+
**Required for `assert-link`** A github auth token (used to set statuses)
2024

2125
### `trigger-phrase`
2226

@@ -30,6 +34,10 @@ This action integrates asana with github.
3034

3135
**Required for `remove-comment`, Optional for `add-comment`** When provided in add-comment, gives a unique identifier that can later be used to delete the comment
3236

37+
### `is-pinned`
38+
39+
**Optional for `add-comment`** Mark a comment as pinned in asana
40+
3341
### `targets`
3442

3543
**Required for `move-section`** JSON array of objects having project and section where to move current task. Move task only if it exists in target project. e.g
@@ -98,8 +106,8 @@ jobs:
98106
steps:
99107
- name: set pr number
100108
run: echo "::set-env name=PR_NUMBER::$(echo -n "${GITHUB_REF}" | awk 'BEGIN { FS = "/" } ; { print $3 }')"
101-
- uses: everphone-gmbh/github-asana-action@5968eaa
102-
if: github.event.pull_request.merged
109+
- uses: everphone-gmbh/github-asana-action
110+
if: github.event.pull_request.merged
103111
with:
104112
asana-pat: ${{ secrets.ASANA_PAT }}
105113
action: 'remove-comment'
@@ -122,7 +130,7 @@ jobs:
122130
with:
123131
asana-pat: ${{ secrets.ASANA_PAT }}
124132
action: assert-link
125-
# if the branch is labeled or hotfix, skip this check
133+
# if the branch is labeled a hotfix, skip this check
126134
link-required: ${{ !contains(github.event.pull_request.labels.*.name, 'hotfix') }}
127135
github-token: ${{ github.token }}
128136
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "github-asana",
3-
"version": "1.0.1",
3+
"version": "4.0.0",
44
"description": "Action to integrate git with asana",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)