docs: add docs
Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
This commit is contained in:
@@ -152,6 +152,7 @@ catalog:
|
||||
# supports ISO duration, "human duration" as used in code
|
||||
timeout: { minutes: 3 }
|
||||
workspace: workspace-name
|
||||
level: workspace # default value
|
||||
```
|
||||
|
||||
> **Note:** It is possible but certainly not recommended to skip the provider ID level.
|
||||
@@ -180,3 +181,7 @@ catalog:
|
||||
- **`workspace`**:
|
||||
Name of your organization account/workspace.
|
||||
If you want to add multiple workspaces, you need to add one provider config each.
|
||||
- **`level`** _(optional)_:
|
||||
`'workspace'` (default) or `'project'`. At what level discovery should take place, affecting Bitbucket Cloud API limits.
|
||||
|
||||
> **Note:** By default, discovery will take place at the `workspace` level. While being the most efficient in terms of API calls to Bitbucket Cloud, discovery at the workspace level is limited to 900 repositories per workspace. If your workspace consists of more than 900 repositories, you should switch to discovery at the `project` level, shifting the limit to 900 repositories per project.
|
||||
|
||||
@@ -60,7 +60,7 @@ export interface Config {
|
||||
*/
|
||||
schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
|
||||
/**
|
||||
* (Optional) On what level discovery should take place, affecting Bitbucket Cloud API limits.
|
||||
* (Optional) At what level discovery should take place, affecting Bitbucket Cloud API limits.
|
||||
*
|
||||
* Possible values:
|
||||
* - `workspace` (default): 1 API call per workspace, limited to 900 repositories per workspace.
|
||||
@@ -101,7 +101,7 @@ export interface Config {
|
||||
*/
|
||||
schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
|
||||
/**
|
||||
* (Optional) On what level discovery should take place, affecting Bitbucket Cloud API limits.
|
||||
* (Optional) At what level discovery should take place, affecting Bitbucket Cloud API limits.
|
||||
*
|
||||
* Possible values:
|
||||
* - `workspace` (default): 1 API call per workspace, limited to 900 repositories per workspace.
|
||||
|
||||
+1
-1
@@ -436,7 +436,7 @@ describe('BitbucketCloudEntityProvider', () => {
|
||||
});
|
||||
});
|
||||
|
||||
it('apply full update on scheduled execution on project-level', async () => {
|
||||
it('apply full update on scheduled execution on project level', async () => {
|
||||
const provider = BitbucketCloudEntityProvider.fromConfig(
|
||||
projectLevelConfig,
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user