docs(catalog): add app to documentation; update config.d.ts
Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
This commit is contained in:
@@ -288,9 +288,11 @@ If you do so, `default` will be used as provider ID.
|
||||
Whether to include archived repositories. Defaults to `false`.
|
||||
- **`host`** _(optional)_:
|
||||
The hostname of your GitHub Enterprise instance. It must match a host defined in [integrations.github](locations.md).
|
||||
- **`organization`**:
|
||||
- **`organization`** _(required, unless `app` is set)_:
|
||||
Name of your organization account/workspace.
|
||||
If you want to add multiple organizations, you need to add one provider config each.
|
||||
If you want to add multiple organizations, you need to add one provider config each or specify `app` instead.
|
||||
- **`app`** _(required, unless `organization` is set)_:
|
||||
ID of your GitHub App.
|
||||
- **`validateLocationsExist`** _(optional)_:
|
||||
Whether to validate locations that exist before emitting them.
|
||||
This option avoids generating locations for catalog info files that do not exist in the source repository.
|
||||
|
||||
+2
-2
@@ -66,7 +66,7 @@ export interface Config {
|
||||
*/
|
||||
organization?: string;
|
||||
/**
|
||||
* (Required, unless `organization` is set) Name of your GitHub App.
|
||||
* (Required, unless `organization` is set) ID of your GitHub App.
|
||||
*/
|
||||
app?: string;
|
||||
/**
|
||||
@@ -144,7 +144,7 @@ export interface Config {
|
||||
*/
|
||||
organization?: string;
|
||||
/**
|
||||
* (Required, unless `organization` is set) Name of your GitHub App.
|
||||
* (Required, unless `organization` is set) ID of your GitHub App.
|
||||
*/
|
||||
app?: string;
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user