Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@ukupat
ukupat authored Jul 9, 2024
1 parent c78c3b5 commit 6b943c7
Showing 1 changed file with 45 additions and 55 deletions.
100 changes: 45 additions & 55 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,164 +43,154 @@ jobs:

## All options

#### `trello-api-key` & `trello-auth-token`
### 1. `trello-api-key` & `trello-auth-token`

**Required:** Visit https://trello.com/app-key
Required: Visit https://trello.com/app-key

**Example:**
Example:

```yaml
trello-api-key: ${{ secrets.TRELLO_API_KEY }}
trello-auth-token: ${{ secrets.TRELLO_AUTH_TOKEN }}
```
#### `github-include-pr-comments`
### 2. `github-include-pr-comments`

Scans PR comments to find Trello card URLs.

**Default:** `true`
Default: `true`

#### `github-include-pr-commit-messages`
### 3. `github-include-pr-commit-messages`

Scans PR commit messages to find Trello card URLs and comments card URL to the PR if found.

**Default:** `false`
Default: `false`

#### `github-include-pr-branch-name`
### 4. `github-include-pr-branch-name`

Uses the branch name to find card id (e.g. feature/38-card-title) and comments card URL to the PR if found.

NB! Make sure you set `pull-requests: write` permission for the job. [Learn more.](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs)

**Default:** `false`
Default: `false`

#### `github-allow-multiple-cards-in-pr-branch-name`
### 5. `github-allow-multiple-cards-in-pr-branch-name`

Allows to reference multiple card short IDs in the branch name (e.g. feature/38-39-40-foo-bar).

NB! Option `github-include-pr-branch-name` needs to be true and it is recommended to set `trello-board-id` to avoid moving wrong cards.

**Default:** `false`
Default: `false`

#### `github-include-new-card-command`
### 6. `github-include-new-card-command`

Creates a new Trello card from PR details if "/new-trello-card" is written in the PR description. Replaces "/new-trello-card" with the card link.

NB! Make sure you set `pull-requests: write` permission for the job. [Learn more.](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs)

**Default:** `false`
Default: `false`

#### `github-require-keyword-prefix`
### 7. `github-require-keyword-prefix`

Only matches Trello URLs prefixed with "Closes" etc.
Only matches Trello URLs prefixed with "Closes" etc. Just like [GitHub Issues + PR work.](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)

Just like [GitHub Issues + PR work.](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
Default: `false`

**Default:** `false`
### 8. `github-enable-related-keyword-prefix`

#### `github-enable-related-keyword-prefix`
Ignores Trello URLs prefixed with "Related". Alternative approach when you don't want to use `github-require-keyword-prefix` but still want to link related cards for extra context.

Ignores Trello URLs prefixed with "Related".
Default: `false`

Alternative approach when you don't want to use `github-require-keyword-prefix` but still want to link related cards for extra context.

**Default:** `false`

#### `github-require-trello-card`
### 9. `github-require-trello-card`

Throws an error if no Trello card can be found in the PR.

**Default:** `false`

#### `github-users-to-trello-users`
Default: `false`

Newline-separated list of mapping between GitHub username and Trello username.
### 10. `github-users-to-trello-users`

Use it for people who have different usernames in GitHub and Trello. If the current username is not in the list, we still try to find a Trello user with GitHub username.
Newline-separated list of mapping between GitHub username and Trello username. Use it for people who have different usernames in GitHub and Trello. If the current username is not in the list, we still try to find a Trello user with GitHub username.

**Example:**
Example:

```yaml
github-users-to-trello-users: |-
GithubUser1:TrelloUser1
GithubUser2:TrelloUser2
```

#### `trello-remove-unrelated-members`
### 11. `trello-remove-unrelated-members`

Removes card members who are not authors, contributors or assignees of the PR.

**Default:** `true`
Default: `true`

#### `trello-list-id-pr-draft`
### 12. `trello-list-id-pr-draft`

Trello list ID for draft pull request. [How to find list ID.](https://stackoverflow.com/a/50908600/2311110)
Trello list ID for draft pull request. [How to find list ID.](https://stackoverflow.com/a/50908600/2311110) Useful when you want to move the card back to "In progress" when ready PR is converted to draft.

Useful when you want to move the card back to "In progress" when ready PR is converted to draft.

#### `trello-list-id-pr-open`
### 13. `trello-list-id-pr-open`

Trello list ID for open pull request. [How to find list ID.](https://stackoverflow.com/a/50908600/2311110)

#### `trello-list-id-pr-changes-requested`
### 14. `trello-list-id-pr-changes-requested`

Trello list ID for a pull request which has at least one review requesting for changes. [How to find list ID.](https://stackoverflow.com/a/50908600/2311110)

NB! Add `pull_request_review` trigger and modify `pull_request` trigger with `review_requested` and `review_request_removed`. [Learn more.](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)

#### `trello-list-id-pr-approved`
### 15. `trello-list-id-pr-approved`

Trello list ID for a pull request which has at least one approve and no reviews requesting for changes. [How to find list ID.](https://stackoverflow.com/a/50908600/2311110)

NB! Add `pull_request_review` trigger and modify `pull_request` trigger with `review_requested` and `review_request_removed`. [Learn more.](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)

#### `trello-list-id-pr-closed`
### 16. `trello-list-id-pr-closed`

Trello list ID for closed pull request. [How to find list ID.](https://stackoverflow.com/a/50908600/2311110)

#### `trello-board-id`

Trello board ID where to move the cards. [How to find board ID.](https://stackoverflow.com/a/50908600/2311110)
### 17. `trello-board-id`

Useful when you want the action to move the card out from a backlog board.
Trello board ID where to move the cards. [How to find board ID.](https://stackoverflow.com/a/50908600/2311110) Useful when you want the action to move the card out from a backlog board.

Separate board IDs with a semicolon to support multiple boards. [Learn more.](https://github.com/rematocorp/trello-integration-action/issues/68)

#### `trello-archive-on-merge`
### 18. `trello-archive-on-merge`

Archives Trello cards when PR is merged.

**Default:** `false`
Default: `false`

#### `trello-card-position`
### 19. `trello-card-position`

Position of the card after being moved to a list.

**Options:** `'top' | 'bottom'`
Options: `'top' | 'bottom'`

**Default:** `'top'`
Default: `'top'`

#### `trello-organization-name`
### 20. `trello-organization-name`

Your organization name to avoid assigning cards to outside members. Edit your workspace details and look for the short name.

**Example:**
Example:

```yaml
trello-organization-name: remato
```

#### `trello-add-labels-to-cards`
### 21. `trello-add-labels-to-cards`

Assigns branch category (e.g. feature/foo) label to Trello card.

**Default:** `true`
Default: `true`

#### `trello-conflicting-labels`
### 22. `trello-conflicting-labels`

When a card already has one of these labels then branch category label is not assigned.

**Example:**
Example:

```yaml
trello-conflicting-labels: 'feature;bug;chore'
Expand Down

0 comments on commit 6b943c7

Please sign in to comment.