Skip to content

Commit fb8212b

Browse files
docs(github-integration): add github app authentication option (#381)
1 parent 64b8bea commit fb8212b

File tree

3 files changed

+27
-1
lines changed

3 files changed

+27
-1
lines changed

docs/integrations/github-containerregistry/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,8 @@ import { releasesWidget } from '@site/docs/widgets/releases';
3535
}, {
3636
credentials: ["personalAccessToken"],
3737
steps: []
38+
}, {
39+
tabLabel: "GitHub App",
40+
credentials: ['githubAppId', 'githubInstallationId', 'privateKey'],
41+
steps: ['Create GitHub App', 'Create a private key for it', 'Install it to your organization / user']
3842
}]} />

docs/integrations/github/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,8 @@ import { releasesWidget } from '@site/docs/widgets/releases';
3434
}, {
3535
credentials: ['personalAccessToken'],
3636
steps: []
37+
}, {
38+
tabLabel: "GitHub App",
39+
credentials: ['githubAppId', 'githubInstallationId', 'privateKey'],
40+
steps: ['Create GitHub App', 'Create a private key for it', 'Install it to your organization / user']
3741
}]} />

src/components/integrations/secrets.tsx

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
import { IconKey, IconKeyOff, IconPassword, IconUser } from '@tabler/icons-react';
1+
import {
2+
IconCode,
3+
IconKey,
4+
IconKeyOff,
5+
IconPassword,
6+
IconPlug,
7+
IconUser,
8+
} from '@tabler/icons-react';
29
import TabItem from '@theme/TabItem';
310
import Tabs from '@theme/Tabs';
411
import { ReactNode } from 'react';
@@ -47,6 +54,17 @@ const secretKinds = {
4754
description: 'The Secret part of the API Key for authentication.',
4855
icon: IconPassword,
4956
},
57+
githubAppId: { name: 'App ID', description: 'The ID of the GitHub App', icon: IconCode },
58+
githubInstallationId: {
59+
name: 'Installation ID',
60+
description: 'The ID of the GitHub Installation',
61+
icon: IconPlug,
62+
},
63+
privateKey: {
64+
name: 'Private Key',
65+
description: 'The private key for authentication',
66+
icon: IconKey,
67+
},
5068
};
5169

5270
type SecretKind = keyof typeof secretKinds;

0 commit comments

Comments
 (0)