feat: appId argument can be set to Client ID string

[oscard0m]

• feat(types): appId allows string or number as type
• test(types): add test coverage for appId new type

Resolves #603

---

Before the change?

appId only allowed number as type.

After the change?

appId allows number or string as type.

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

• Yes
• No

---

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[gr2m]

can you also remove

auth-app.js/src/index.ts

Lines 34 to 38 in 81ac6ec

	if (!Number.isFinite(+options.appId)) {
	throw new Error(
	"[@octokit/auth-app] appId option must be a number or numeric string",
	);
	}

and cover the change of behavior? It is technically a breaking change in behavior, but in this particular case I'd suggest we do a fix release, as it reflects a change in GitHub's API.

[wolfy1339]

For a later date, maybe we could use template literal strings to better define the format

Suggested change

	appId: number | string;
	appId: number | `Iv1.${string}`;

[oscard0m]

Yep, this would imply a change in universal-github-app-jwt first. Do you want me to open an issue there first?

[gr2m]

appId: number | Iv1.${string};

I wouldn't do that, because there is a chance that future Client IDs will start with lv2.... and I also think there are old apps that still have a client ID without the lv1 prefix

[gr2m]

@oscard0m if it's done from your side, can you let me merge it please? I want to test out the latest semantic-release beta version in a real-life environment

[oscard0m]

@oscard0m if it's done from your side, can you let me merge it please? I want to test out the latest semantic-release beta version in a real-life environment

go for it @gr2m

[github-actions]

🎉 This PR is included in version 7.1.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[joebowbeer]

@oscard0m should I create an issue to update the README?

By my reading, the appId is required and clientId is optional, which confused me.

I didn't see any mention that clientId could be assigned to appId.

[gr2m]

@oscard0m should I create an issue to update the README?

that would be great, thank you!