Skip to content

Commit

Permalink
Make even wider
Browse files Browse the repository at this point in the history
  • Loading branch information
@ukupat
ukupat committed Dec 21, 2023
1 parent cea01c6 commit abe13ad
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,25 @@ jobs:
## All options
|             Option             | Default | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `github-token` | | **REQUIRED** |
| `trello-api-token` | | **REQUIRED** Visit https://trello.com/app-key. |
| `trello-auth-token` | | **REQUIRED** Visit https://trello.com/app-key and click "Generate a token". |
| `github-include-pr-comments` | `true` | Scans PR comments to find Trello card URLs. |
| `github-include-pr-branch-name` | `false` | Uses the branch name to find card id (e.g. `feature/38-card-title`). Comments card link to the PR if found. |
| `github-require-keyword-prefix` | `false` | Only matches Trello URLs prefixed with ["Closes" etc](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). |
| `github-require-trello-card` | `false` | Throws an error if no Trello card can be found in the PR. |
| `trello-list-id-pr-draft` | | Trello list ID for draft pull request. Useful when you want to move the card back to "In progress" when ready PR is converted to draft. [How to find list ID](https://stackoverflow.com/a/50908600/2311110). |
| `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-closed` | | Trello list ID for closed (merged) pull request. [How to find list ID](https://stackoverflow.com/a/50908600/2311110). |
| `trello-board-id` | | Trello board ID where to move the cards. Useful when you want the action to move the card out from the backlog. [How to find board ID](https://stackoverflow.com/a/50908600/2311110). |
| `trello-card-position` | `'top'` | Position of the card after being moved to a list. Options: `'top'` or `'bottom'`. |
| `github-users-to-trello-users` | | 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. Look below to see an example. |
| `trello-organization-name` | | Your organization name to avoid assigning cards to outside members, edit your workspace details and look for the short name. |
| `trello-remove-unrelated-members` | `true` | Removes card members who are not authors or assignees of the PR. |
| `trello-add-labels-to-cards` | `true` | Assigns branch category (e.g. `feature/foo`) label to Trello card. |
| `trello-conflicting-labels` | `true` | When a card has one of these labels then branch category label is not assigned. Separate label names with `;`. |
|                         Option                         | Default | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `github-token` | | **REQUIRED** |
| `trello-api-token` | | **REQUIRED** Visit https://trello.com/app-key. |
| `trello-auth-token` | | **REQUIRED** Visit https://trello.com/app-key and click "Generate a token". |
| `github-include-pr-comments` | `true` | Scans PR comments to find Trello card URLs. |
| `github-include-pr-branch-name` | `false` | Uses the branch name to find card id (e.g. `feature/38-card-title`). Comments card link to the PR if found. |
| `github-require-keyword-prefix` | `false` | Only matches Trello URLs prefixed with ["Closes" etc](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). |
| `github-require-trello-card` | `false` | Throws an error if no Trello card can be found in the PR. |
| `trello-list-id-pr-draft` | | Trello list ID for draft pull request. Useful when you want to move the card back to "In progress" when ready PR is converted to draft. [How to find list ID](https://stackoverflow.com/a/50908600/2311110). |
| `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-closed` | | Trello list ID for closed (merged) pull request. [How to find list ID](https://stackoverflow.com/a/50908600/2311110). |
| `trello-board-id` | | Trello board ID where to move the cards. Useful when you want the action to move the card out from the backlog. [How to find board ID](https://stackoverflow.com/a/50908600/2311110). |
| `trello-card-position` | `'top'` | Position of the card after being moved to a list. Options: `'top'` or `'bottom'`. |
| `github-users-to-trello-users` | | 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. Look below to see an example. |
| `trello-organization-name` | | Your organization name to avoid assigning cards to outside members, edit your workspace details and look for the short name. |
| `trello-remove-unrelated-members` | `true` | Removes card members who are not authors or assignees of the PR. |
| `trello-add-labels-to-cards` | `true` | Assigns branch category (e.g. `feature/foo`) label to Trello card. |
| `trello-conflicting-labels` | `true` | When a card has one of these labels then branch category label is not assigned. Separate label names with `;`. |

## Examples

Expand Down

0 comments on commit abe13ad

Please sign in to comment.