feat: add `client-id` input and deprecate `app-id` by Copilot · Pull Request #353 · actions/create-github-app-token · GitHub
Skip to content

feat: 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.

Sign up for GitHub

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

Merged
parkerbxyz merged 13 commits into from
Apr 11, 2026
Merged

feat: add client-id input and deprecate app-id #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
e9da442
Initial plan
Copilot Mar 18, 2026
8204e76
docs: document client ID support for app-id
Copilot Mar 18, 2026
37f42c5
feat: add client-id input and deprecate app-id
Copilot Mar 18, 2026
ea0d315
refactor: rename internal appId variable to clientId
parkerbxyz Mar 20, 2026
136ba78
fix: avoid environment-dependent stack trace in error test snapshot
parkerbxyz Mar 20, 2026
188519e
docs: update environment variable names
parkerbxyz Mar 20, 2026
1a28837
Merge branch 'main' into copilot/v3-breaking-changes-tracking
parkerbxyz Apr 10, 2026
7bff131
docs: correct relative links in tests README
parkerbxyz Apr 10, 2026
c879648
refactor: use client-id as default test env, add app-id fallback test
parkerbxyz Apr 10, 2026
1ac89dd
docs: combine client-id and app-id into single input section
parkerbxyz Apr 10, 2026
0ff66ea
docs: update outdated GitHub Docs links
parkerbxyz Apr 10, 2026
3dde775
test: add client-id precedence test when both inputs are set
parkerbxyz Apr 11, 2026
7f7e950
docs: streamline README intro and input section
parkerbxyz Apr 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 30 additions & 27 deletions README.md
View file
Open in desktop
6 changes: 5 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ branding:
icon: "lock"
color: "gray-dark"
inputs:
client-id:
description: "GitHub App Client ID"
required: false
app-id:
description: "GitHub App ID"
required: true
required: false
deprecationMessage: "Use 'client-id' instead."
private-key:
description: "GitHub App private key"
required: true
Expand Down
11 changes: 7 additions & 4 deletions dist/main.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23153,7 +23153,7 @@ async function pRetry(input, options = {}) {
}

// lib/main.js
async function main(appId, privateKey, owner, repositories, permissions, core, createAppAuth2, request2, skipTokenRevoke) {
async function main(clientId, privateKey, owner, repositories, permissions, core, createAppAuth2, request2, skipTokenRevoke) {
let parsedOwner = "";
let parsedRepositoryNames = [];
if (!owner && repositories.length === 0) {
Expand Down Expand Up @@ -23188,7 +23188,7 @@ async function main(appId, privateKey, owner, repositories, permissions, core, c
);
}
const auth5 = createAppAuth2({
appId,
appId: clientId,
privateKey,
request: request2
});
Expand Down Expand Up @@ -23307,14 +23307,17 @@ if (!process.env.GITHUB_REPOSITORY_OWNER) {
}
async function run() {
ensureNativeProxySupport();
const appId = getInput("app-id");
const clientId = getInput("client-id") || getInput("app-id");
if (!clientId) {
throw new Error("Either 'client-id' or 'app-id' input must be set");
}
const privateKey = getInput("private-key");
const owner = getInput("owner");
const repositories = getInput("repositories").split(/[\n,]+/).map((s) => s.trim()).filter((x) => x !== "");
const skipTokenRevoke = getBooleanInput("skip-token-revoke");
const permissions = getPermissionsFromInputs(process.env);
return main(
appId,
clientId,
privateKey,
owner,
repositories,
Expand Down
6 changes: 3 additions & 3 deletions lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import pRetry from "p-retry";
// @ts-check

/**
* @param {string} appId
* @param {string} clientId
Comment thread
parkerbxyz marked this conversation as resolved.
* @param {string} privateKey
* @param {string} owner
* @param {string[]} repositories
Expand All @@ -13,7 +13,7 @@ import pRetry from "p-retry";
* @param {boolean} skipTokenRevoke
*/
export async function main(
appId,
clientId,
privateKey,
owner,
repositories,
Expand Down Expand Up @@ -70,7 +70,7 @@ export async function main(
}

const auth = createAppAuth({
appId,
appId: clientId,
Comment thread
parkerbxyz marked this conversation as resolved.
privateKey,
request,
});
Comment thread
parkerbxyz marked this conversation as resolved.
Expand Down
7 changes: 5 additions & 2 deletions main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 thread
parkerbxyz marked this conversation as resolved.
Comment thread
parkerbxyz marked this conversation as resolved.
const privateKey = core.getInput("private-key");
const owner = core.getInput("owner");
const repositories = core
Expand All @@ -32,7 +35,7 @@ async function run() {
const permissions = getPermissionsFromInputs(process.env);

return main(
appId,
clientId,
privateKey,
owner,
repositories,
Expand Down
4 changes: 2 additions & 2 deletions tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ node --test --test-update-snapshots tests/index.js

We have tests both for the `main.js` and `post.js` scripts.

- If you do not expect an error, take [main-token-permissions-set.test.js](tests/main-token-permissions-set.test.js) as a starting point.
- If your test has an expected error, take [main-missing-app-id.test.js](tests/main-missing-app-id.test.js) as a starting point.
- If you do not expect an error, take [main-token-permissions-set.test.js](main-token-permissions-set.test.js) as a starting point.
- If your test has an expected error, take [main-missing-client-and-app-id.test.js](main-missing-client-and-app-id.test.js) as a starting point.
46 changes: 46 additions & 0 deletions tests/index.js.snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
exports[`action-deprecated-inputs.test.js > stdout 1`] = `
app-id — Use 'client-id' instead.
`;

exports[`main-app-id-fallback.test.js > stdout 1`] = `
Inputs 'owner' and 'repositories' are not set. Creating token for this repository (actions/create-github-app-token).
::add-mask::ghs_16C7e42F292c6912E7710c838347Ae178B4a

::set-output name=token::ghs_16C7e42F292c6912E7710c838347Ae178B4a

::set-output name=installation-id::123456

::set-output name=app-slug::github-actions
::save-state name=token::ghs_16C7e42F292c6912E7710c838347Ae178B4a
::save-state name=expiresAt::2016-07-11T22:14:10Z
--- REQUESTS ---
GET /repos/actions/create-github-app-token/installation
POST /app/installations/123456/access_tokens
{"repositories":["create-github-app-token"]}
`;

exports[`main-client-id-precedence.test.js > stdout 1`] = `
Inputs 'owner' and 'repositories' are not set. Creating token for this repository (actions/create-github-app-token).
::add-mask::ghs_16C7e42F292c6912E7710c838347Ae178B4a

::set-output name=token::ghs_16C7e42F292c6912E7710c838347Ae178B4a

::set-output name=installation-id::123456

::set-output name=app-slug::github-actions
::save-state name=token::ghs_16C7e42F292c6912E7710c838347Ae178B4a
::save-state name=expiresAt::2016-07-11T22:14:10Z
--- REQUESTS ---
GET /repos/actions/create-github-app-token/installation
POST /app/installations/123456/access_tokens
{"repositories":["create-github-app-token"]}
`;

exports[`main-custom-github-api-url.test.js > stdout 1`] = `
Inputs 'owner' and 'repositories' are set. Creating token for the following repositories:

Expand All @@ -17,6 +55,14 @@ POST /api/v3/app/installations/123456/access_tokens
{"repositories":["create-github-app-token"]}
`;

exports[`main-missing-client-and-app-id.test.js > stderr 1`] = `
Either 'client-id' or 'app-id' input must be set
`;

exports[`main-missing-client-and-app-id.test.js > stdout 1`] = `
::error::Either 'client-id' or 'app-id' input must be set
`;

exports[`main-missing-owner.test.js > stderr 1`] = `
GITHUB_REPOSITORY_OWNER missing, must be set to '<owner>'
`;
Expand Down
11 changes: 11 additions & 0 deletions tests/main-app-id-fallback.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { DEFAULT_ENV, test } from "./main.js";

// Verify `main` falls back to `app-id` when `client-id` is not set
await test(
() => {},
{
...DEFAULT_ENV,
"INPUT_CLIENT-ID": "",
"INPUT_APP-ID": "123456",
}
);
11 changes: 11 additions & 0 deletions tests/main-client-id-precedence.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { DEFAULT_ENV, test } from "./main.js";

// Verify `client-id` takes precedence when both `client-id` and `app-id` are set
await test(
() => {},
{
...DEFAULT_ENV,
"INPUT_CLIENT-ID": "Iv1.0123456789abcdef",
"INPUT_APP-ID": "123456",
}
);
Comment thread
parkerbxyz marked this conversation as resolved.
20 changes: 20 additions & 0 deletions tests/main-missing-client-and-app-id.test.js
View file
Open in desktop
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;
2 changes: 1 addition & 1 deletion tests/main.js
View file
Open in desktop
Loading