Default flow results in error for missing installationId

[spew]

What happened?

The README.md gives the following code example for authenticating as an app.

const appOctokit = new Octokit({
  authStrategy: createAppAuth,
  auth: {
    appId: 1,
    privateKey: "-----BEGIN PRIVATE KEY-----\n...",
    clientId: "1234567890abcdef1234",
    clientSecret: "1234567890abcdef1234567890abcdef12345678",
  },
});

// Send requests as GitHub App
const { slug } = await appOctokit.request("GET /user");
console.log("authenticated as %s", slug);

If one tries to use this code (with valid values for the private key, client secret, etc), the following client-side error occurs:

installationId option is required for installation authentication

This means the library is unuseable without an app installation. If this is desired and correct behavior, then please adjust the README examples.

Versions

Octokit 3.1.2
Node v18.17.0

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[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]

It's /app, not /user. Try this instead

const { slug } = await appOctokit.request("GET /app");
console.log("authenticated as %s", slug);

[spew]

Right, but the README says to use GET /user (Line 248: https://github.com/octokit/auth-app.js/blob/main/README.md?plain=1#L248).

The implication is that an app could make requests like, "list users" and things like that without having an installation. However, this is impossible.

[gr2m]

Cheers! I'll get that fixed

[github-actions]

🎉 This issue has been resolved in version 6.0.4 🎉

The release is available on:

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

Your semantic-release bot 📦🚀