-
Notifications
You must be signed in to change notification settings - Fork 141
Add client-id input and deprecate app-id
#353
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Copilot
wants to merge
6
commits into
main
Choose a base branch
from
copilot/v3-breaking-changes-tracking
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+118
−37
Draft
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e9da442
Initial plan
Copilot 8204e76
docs: document client ID support for app-id
Copilot 37f42c5
feat: add client-id input and deprecate app-id
Copilot ea0d315
refactor: rename internal appId variable to clientId
parkerbxyz 136ba78
fix: avoid environment-dependent stack trace in error test snapshot
parkerbxyz 188519e
docs: update environment variable names
parkerbxyz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,7 +18,10 @@ if (!process.env.GITHUB_REPOSITORY_OWNER) { | |
| async function run() { | ||
| ensureNativeProxySupport(); | ||
|
|
||
| const appId = core.getInput("app-id"); | ||
| const clientId = core.getInput("client-id") || core.getInput("app-id"); | ||
| if (!clientId) { | ||
| throw new Error("Either 'client-id' or 'app-id' input must be set"); | ||
| } | ||
|
Comment on lines
+21
to
+24
|
||
| const privateKey = core.getInput("private-key"); | ||
| const owner = core.getInput("owner"); | ||
| const repositories = core | ||
|
|
@@ -32,7 +35,7 @@ async function run() { | |
| const permissions = getPermissionsFromInputs(process.env); | ||
|
|
||
| return main( | ||
| appId, | ||
| clientId, | ||
| privateKey, | ||
| owner, | ||
| repositories, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { DEFAULT_ENV, test } from "./main.js"; | ||
|
|
||
| // Verify `main` accepts a GitHub App client ID via the `client-id` input | ||
| await test( | ||
| () => {}, | ||
| { | ||
| ...DEFAULT_ENV, | ||
| "INPUT_CLIENT-ID": "Iv1.0123456789abcdef", | ||
| "INPUT_APP-ID": "", | ||
| } | ||
| ); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { DEFAULT_ENV } from "./main.js"; | ||
|
|
||
| for (const [key, value] of Object.entries({ | ||
| ...DEFAULT_ENV, | ||
| "INPUT_CLIENT-ID": "", | ||
| "INPUT_APP-ID": "", | ||
| })) { | ||
| process.env[key] = value; | ||
| } | ||
|
|
||
| // Log only the error message, not the full stack trace, because the stack | ||
| // trace contains environment-specific paths and ANSI codes that differ | ||
| // between local and CI environments. | ||
| const _error = console.error; | ||
| console.error = (err) => _error(err?.message ?? err); | ||
|
|
||
| // Verify `main` exits with an error when neither `client-id` nor `app-id` is set. | ||
| const { default: promise } = await import("../main.js"); | ||
| await promise; | ||
| process.exitCode = 0; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The JSDoc and parameter name (
clientId) suggest this argument is always a GitHub App Client ID, but callers pass eitherclient-idor legacyapp-idhere. Tweaking the docs/parameter name to reflect that it can be either (e.g.,appIdOrClientId) would make intent clearer, especially since it’s mapped intocreateAppAuth({ appId: ... }).