Skip to content
This repository was archived by the owner on Jun 9, 2021. It is now read-only.

Commit 100d559

Browse files
tomasbjerretomasbjerre
authored
Merge pull request #186 from Rychard/readme-table
Use table instead of list for variable documentation
2 parents aa26ba0 + bfea25b commit 100d559

File tree

1 file changed

+55
-53
lines changed

1 file changed

+55
-53
lines changed

‎README.md‎

Lines changed: 55 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -47,59 +47,61 @@ The plugin has its own implementation to create the RESCOPED_FROM and RESCOPED_T
4747

4848
The filter text as well as the URL support variables. These are:
4949

50-
* ${EVERYTHING_URL} This variable is resolved to all available variables. The name of each parameter is the name of that variable. Example: PULL_REQUEST_ID=1&PULL_REQUEST_TITLE=some%20thing...
51-
* ${PULL_REQUEST_ID} Example: 1
52-
* ${PULL_REQUEST_TITLE} Example: Anything
53-
* ${PULL_REQUEST_DESCRIPTION} The ${EVERYTHING_URL} does not include this because it makes the URL very big. Example: Anything
54-
* ${PULL_REQUEST_VERSION} Example: 1
55-
* ${PULL_REQUEST_COMMENT_TEXT} Example: A comment
56-
* ${PULL_REQUEST_COMMENT_ACTION} Example: ADDED, DELETED, EDITED, REPLIED
57-
* ${PULL_REQUEST_ACTION} Example: OPENED
58-
* ${PULL_REQUEST_STATE} Example: DECLINED, MERGED, OPEN
59-
* ${BUTTON_TRIGGER_TITLE} Example: Trigger Notification
60-
* ${BUTTON_FORM_DATA} The form data that was submitted
61-
* ${INJECTION_URL_VALUE} Value retrieved from any URL
62-
* ${PULL_REQUEST_URL} Example: http://localhost:7990/projects/PROJECT_1/repos/rep_1/pull-requests/1
63-
* ${PULL_REQUEST_USER_DISPLAY_NAME} Example: Some User
64-
* ${PULL_REQUEST_USER_EMAIL_ADDRESS} Example: some.user@bitbucket.domain
65-
* ${PULL_REQUEST_USER_ID} Example: 1
66-
* ${PULL_REQUEST_USER_NAME} Example: user.name
67-
* ${PULL_REQUEST_USER_SLUG} Example: user.name
68-
* ${PULL_REQUEST_AUTHOR_DISPLAY_NAME} Example: Administrator
69-
* ${PULL_REQUEST_AUTHOR_EMAIL} Example: admin@example.com
70-
* ${PULL_REQUEST_AUTHOR_ID} Example: 1
71-
* ${PULL_REQUEST_AUTHOR_NAME} Example: admin
72-
* ${PULL_REQUEST_AUTHOR_SLUG} Example: admin
73-
* ${PULL_REQUEST_REVIEWERS} Example: Administrator,User
74-
* ${PULL_REQUEST_REVIEWERS_ID} Example: 1,2
75-
* ${PULL_REQUEST_REVIEWERS_SLUG} Example: admin,user
76-
* ${PULL_REQUEST_REVIEWERS_EMAIL} Example: admin@example.com,user@example.com
77-
* ${PULL_REQUEST_REVIEWERS_APPROVED_COUNT} Number of reviewers that approved the PR.
78-
* ${PULL_REQUEST_REVIEWERS_UNAPPROVED_COUNT} Number of reviewers that unapproved the PR.
79-
* ${PULL_REQUEST_REVIEWERS_NEEDS_WORK_COUNT} Number of reviewers that says the PR needs work.
80-
* ${PULL_REQUEST_PARTICIPANTS_APPROVED_COUNT} Number of participants that approved the PR.
81-
* ${PULL_REQUEST_PARTICIPANTS_EMAIL} Example: admin@example.com,user@example.com
82-
* ${PULL_REQUEST_MERGE_COMMIT} Hash of merged commit (only available for merged-event).
83-
* ${PULL_REQUEST_FROM_SSH_CLONE_URL} Example: ssh://git@localhost:7999/project_1/rep_1
84-
* ${PULL_REQUEST_FROM_HTTP_CLONE_URL} Example: http://admin@localhost:7990/bitbucket/scm/project_1/rep_1.git
85-
* ${PULL_REQUEST_FROM_HASH} Example: 6053a1eaa1c009dd11092d09a72f3c41af1b59ad
86-
* ${PULL_REQUEST_FROM_ID} Example: refs/heads/branchmodmerge
87-
* ${PULL_REQUEST_FROM_BRANCH} Example: branchmodmerge
88-
* ${PULL_REQUEST_FROM_REPO_ID} Example: 1
89-
* ${PULL_REQUEST_FROM_REPO_NAME} Example: rep_1
90-
* ${PULL_REQUEST_FROM_REPO_PROJECT_ID} Example: 1
91-
* ${PULL_REQUEST_FROM_REPO_PROJECT_KEY} Example: PROJECT_1
92-
* ${PULL_REQUEST_FROM_REPO_SLUG} Example: rep_1
93-
* ${PULL_REQUEST_TO_SSH_CLONE_URL} Example: ssh://git@localhost:7999/project_1/rep_1
94-
* ${PULL_REQUEST_TO_HTTP_CLONE_URL} Example: http://admin@localhost:7990/bitbucket/scm/project_1/rep_1.git
95-
* ${PULL_REQUEST_TO_HASH} Example: 6053a1eaa1c009dd11092d09a72f3c41af1b59ad
96-
* ${PULL_REQUEST_TO_ID} Example: refs/heads/branchmodmerge
97-
* ${PULL_REQUEST_TO_BRANCH} Example: branchmodmerge
98-
* ${PULL_REQUEST_TO_REPO_ID} Example: 1
99-
* ${PULL_REQUEST_TO_REPO_NAME} Example: rep_1
100-
* ${PULL_REQUEST_TO_REPO_PROJECT_ID} Example: 1
101-
* ${PULL_REQUEST_TO_REPO_PROJECT_KEY} Example: PROJECT_1
102-
* ${PULL_REQUEST_TO_REPO_SLUG} Example: rep_1
50+
| Variable | Description |
51+
| :------- | :---------- |
52+
| `${EVERYTHING_URL}` | This variable is resolved to all available variables. The name of each parameter is the name of that variable. <br /> Example: `PULL_REQUEST_ID=1&PULL_REQUEST_TITLE=some%20thing...` |
53+
| `${PULL_REQUEST_ID}` | Example: `1` |
54+
| `${PULL_REQUEST_TITLE}` | Example: `Anything` |
55+
| `${PULL_REQUEST_DESCRIPTION}` | The `${EVERYTHING_URL}` does not include this because it makes the URL very big. | Example: Anything |
56+
| `${PULL_REQUEST_VERSION}` | Example: `1` |
57+
| `${PULL_REQUEST_COMMENT_TEXT}` | Example: `A comment` |
58+
| `${PULL_REQUEST_COMMENT_ACTION}` | Example: `ADDED`, `DELETED`, `EDITED`, `REPLIED` |
59+
| `${PULL_REQUEST_ACTION}` | Example: `OPENED` |
60+
| `${PULL_REQUEST_STATE}` | Example: `DECLINED`, `MERGED`, `OPEN` |
61+
| `${BUTTON_TRIGGER_TITLE}` | Example: `Trigger Notification` |
62+
| `${BUTTON_FORM_DATA}` | The form data that was submitted |
63+
| `${INJECTION_URL_VALUE}` | Value retrieved from any URL |
64+
| `${PULL_REQUEST_URL}` | Example: `http://localhost:7990/projects/PROJECT_1/repos/rep_1/pull-requests/1` |
65+
| `${PULL_REQUEST_USER_DISPLAY_NAME}` | Example: `Some User` |
66+
| `${PULL_REQUEST_USER_EMAIL_ADDRESS}` | Example: `some.user@bitbucket.domain` |
67+
| `${PULL_REQUEST_USER_ID}` | Example: `1` |
68+
| `${PULL_REQUEST_USER_NAME}` | Example: `user.name` |
69+
| `${PULL_REQUEST_USER_SLUG}` | Example: `user.name` |
70+
| `${PULL_REQUEST_AUTHOR_DISPLAY_NAME}` | Example: `Administrator` |
71+
| `${PULL_REQUEST_AUTHOR_EMAIL}` | Example: `admin@example.com` |
72+
| `${PULL_REQUEST_AUTHOR_ID}` | Example: `1` |
73+
| `${PULL_REQUEST_AUTHOR_NAME}` | Example: `admin` |
74+
| `${PULL_REQUEST_AUTHOR_SLUG}` | Example: `admin` |
75+
| `${PULL_REQUEST_REVIEWERS}` | Example: `Administrator,User` |
76+
| `${PULL_REQUEST_REVIEWERS_ID}` | Example: `1,2` |
77+
| `${PULL_REQUEST_REVIEWERS_SLUG}` | Example: `admin,user` |
78+
| `${PULL_REQUEST_REVIEWERS_EMAIL}` | Example: `admin@example.com,user@example.com` |
79+
| `${PULL_REQUEST_REVIEWERS_APPROVED_COUNT}` | Number of reviewers that approved the PR. |
80+
| `${PULL_REQUEST_REVIEWERS_UNAPPROVED_COUNT}` | Number of reviewers that unapproved the PR. |
81+
| `${PULL_REQUEST_REVIEWERS_NEEDS_WORK_COUNT}` | Number of reviewers that says the PR needs work. |
82+
| `${PULL_REQUEST_PARTICIPANTS_APPROVED_COUNT}` | Number of participants that approved the PR. |
83+
| `${PULL_REQUEST_PARTICIPANTS_EMAIL}` | Example: `admin@example.com,user@example.com` |
84+
| `${PULL_REQUEST_MERGE_COMMIT}` | Hash of merged commit (only available for merged-event). |
85+
| `${PULL_REQUEST_FROM_SSH_CLONE_URL}` | Example: `ssh://git@localhost:7999/project_1/rep_1` |
86+
| `${PULL_REQUEST_FROM_HTTP_CLONE_URL}` | Example: `http://admin@localhost:7990/bitbucket/scm/project_1/rep_1.git` |
87+
| `${PULL_REQUEST_FROM_HASH}` | Example: `6053a1eaa1c009dd11092d09a72f3c41af1b59ad` |
88+
| `${PULL_REQUEST_FROM_ID}` | Example: `refs/heads/branchmodmerge` |
89+
| `${PULL_REQUEST_FROM_BRANCH}` | Example: `branchmodmerge` |
90+
| `${PULL_REQUEST_FROM_REPO_ID}` | Example: `1` |
91+
| `${PULL_REQUEST_FROM_REPO_NAME}` | Example: `rep_1` |
92+
| `${PULL_REQUEST_FROM_REPO_PROJECT_ID}` | Example: `1` |
93+
| `${PULL_REQUEST_FROM_REPO_PROJECT_KEY}` | Example: `PROJECT_1` |
94+
| `${PULL_REQUEST_FROM_REPO_SLUG}` | Example: `rep_1` |
95+
| `${PULL_REQUEST_TO_SSH_CLONE_URL}` | Example: `ssh://git@localhost:7999/project_1/rep_1` |
96+
| `${PULL_REQUEST_TO_HTTP_CLONE_URL}` | Example: `http://admin@localhost:7990/bitbucket/scm/project_1/rep_1.git` |
97+
| `${PULL_REQUEST_TO_HASH}` | Example: `6053a1eaa1c009dd11092d09a72f3c41af1b59ad` |
98+
| `${PULL_REQUEST_TO_ID}` | Example: `refs/heads/branchmodmerge` |
99+
| `${PULL_REQUEST_TO_BRANCH}` | Example: `branchmodmerge` |
100+
| `${PULL_REQUEST_TO_REPO_ID}` | Example: `1` |
101+
| `${PULL_REQUEST_TO_REPO_NAME}` | Example: `rep_1` |
102+
| `${PULL_REQUEST_TO_REPO_PROJECT_ID}` | Example: `1` |
103+
| `${PULL_REQUEST_TO_REPO_PROJECT_KEY}` | Example: `PROJECT_1` |
104+
| `${PULL_REQUEST_TO_REPO_SLUG}` | Example: `rep_1` |
103105

104106
The ${PULL_REQUEST_USER...} contains information about the user who issued the event. Who commented it, who rejected it, who approved it...
105107

0 commit comments

Comments
 (0)