Skip to content

Commit 552478e

Browse files
committed
Feedback from Lindsey: rearrange optional inputs
1 parent 1f1a6b0 commit 552478e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ jobs:
4646
REPLACE_THIS
4747
repository: REPLACE_THIS/REPLACE_THIS # Provide a repository name-with-owner (in the format "primer/primer-docs"). This is where issues will be filed and where Copilot will open PRs; more information below.
4848
token: ${{ secrets.GH_TOKEN }} # This token must have write access to the repo above (contents, issues, and PRs); more information below. Note: GitHub Actions' GITHUB_TOKEN cannot be used here.
49-
# base_url: https://REPLACE_THIS # Optional: GitHub API base URL to pass into Octokit (required for GitHub Enterprise Server)
5049
cache_key: REPLACE_THIS # Provide a filename that will be used when caching results. We recommend including the name or domain of the site being scanned.
50+
# base_url: https://REPLACE_THIS # Optional: GitHub API base URL to pass into Octokit (required for GitHub Enterprise Server)
5151
# login_url: # Optional: URL of the login page if authentication is required
5252
# username: # Optional: Username for authentication
5353
# password: ${{ secrets.PASSWORD }} # Optional: Password for authentication (use secrets!)
@@ -118,8 +118,8 @@ Trigger the workflow manually or automatically based on your configuration. The
118118
| `urls` | Yes | Newline-delimited list of URLs to scan | `https://primer.style`<br>`https://primer.style/octicons` |
119119
| `repository` | Yes | Repository (with owner) for issues and PRs | `primer/primer-docs` |
120120
| `token` | Yes | PAT with write permissions (see above) | `${{ secrets.GH_TOKEN }}` |
121-
| `base_url` | No | GitHub API base URL used by Octokit. Set this for GitHub Enterprise Server (format: `https://HOSTNAME/api/v3`). Defaults to `https://api.github.com` | `https://ghe.example.com/api/v3` |
122121
| `cache_key` | Yes | Key for caching results across runs<br>Allowed: `A-Za-z0-9._/-` | `cached_results-primer.style-main.json` |
122+
| `base_url` | No | GitHub API base URL used by Octokit. Set this for GitHub Enterprise Server (format: `https://HOSTNAME/api/v3`). Defaults to `https://api.github.com` | `https://ghe.example.com/api/v3` |
123123
| `login_url` | No | If scanned pages require authentication, the URL of the login page | `https://github.com/login` |
124124
| `username` | No | If scanned pages require authentication, the username to use for login | `some-user` |
125125
| `password` | No | If scanned pages require authentication, the password to use for login | `${{ secrets.PASSWORD }}` |

0 commit comments

Comments
 (0)