Skip to content

Commit aafbe08

Browse files
chore(deps): upgrade dependencies (#4)
Upgrades project dependencies. See details in [workflow run]. [Workflow Run]: https://github.com/flochaz/synthetics-canaries-e2e-tests-runner/actions/runs/1231811908 ------ *Automatically created by projen via the "upgrade" workflow* Co-authored-by: flochaz <flochaz@users.noreply.github.com>
1 parent e26e977 commit aafbe08

File tree

4 files changed

+665
-664
lines changed

4 files changed

+665
-664
lines changed

API.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Run and Evaluate AWS Cloudwatch Canaries parallel with AWS Step Functions.
88

99
State machine's execution will fail if any of the canaries fail but it will wait for all to run before failing.
1010

11-
#### Initializer <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.Initializer"></a>
11+
#### Initializers <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.Initializer"></a>
1212

1313
```typescript
1414
import { StepFunctionOrchestrator } from 'synthetics-canaries-e2e-tests-runner'
@@ -40,6 +40,10 @@ new StepFunctionOrchestrator(scope: Construct, id: string, props: StepFunctionOr
4040

4141
##### `stateMachine`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.property.stateMachine"></a>
4242

43+
```typescript
44+
public readonly stateMachine: StateMachine;
45+
```
46+
4347
- *Type:* [`@aws-cdk/aws-stepfunctions.StateMachine`](#@aws-cdk/aws-stepfunctions.StateMachine)
4448

4549
---
@@ -61,6 +65,10 @@ const e2ETestsStepProps: E2ETestsStepProps = { ... }
6165

6266
##### `canaries`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.canaries"></a>
6367

68+
```typescript
69+
public readonly canaries: Canary[];
70+
```
71+
6472
- *Type:* [`@aws-cdk/aws-synthetics.Canary`](#@aws-cdk/aws-synthetics.Canary)[]
6573

6674
Array of AWS Cloudwatch canary to execute in this step.
@@ -69,6 +77,10 @@ Array of AWS Cloudwatch canary to execute in this step.
6977

7078
##### `inputsFromDeployedStack`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.inputsFromDeployedStack"></a>
7179

80+
```typescript
81+
public readonly inputsFromDeployedStack: CfnOutput[];
82+
```
83+
7284
- *Type:* [`@aws-cdk/core.CfnOutput`](#@aws-cdk/core.CfnOutput)[]
7385

7486
The potential list of CloudFormation outputs exposed by the App under test deployed in the previous step of the code pipeline workflow and that are needed by canaries to run properly.
@@ -80,6 +92,10 @@ Those will be pushed to AWS SSM Parameter store to be accessed by the canary at
8092

8193
##### `scope`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.scope"></a>
8294

95+
```typescript
96+
public readonly scope: Construct;
97+
```
98+
8399
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
84100

85101
Scope in wich to instantiate the state machine (usually your pipeline stack).
@@ -100,6 +116,10 @@ const stepFunctionOrchestratorProps: StepFunctionOrchestratorProps = { ... }
100116

101117
##### `canaries`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestratorProps.property.canaries"></a>
102118

119+
```typescript
120+
public readonly canaries: Canary[];
121+
```
122+
103123
- *Type:* [`@aws-cdk/aws-synthetics.Canary`](#@aws-cdk/aws-synthetics.Canary)[]
104124

105125
Array of AWS Cloudwatch canary to execute.
@@ -114,7 +134,7 @@ Array of AWS Cloudwatch canary to execute.
114134

115135
Run AWS Cloudwatch Canaries end to end tests in parallel in the pipeline.
116136

117-
#### Initializer <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStep.Initializer"></a>
137+
#### Initializers <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStep.Initializer"></a>
118138

119139
```typescript
120140
import { E2ETestsStep } from 'synthetics-canaries-e2e-tests-runner'
@@ -159,12 +179,20 @@ public produceAction(stage: IStage, options: ProduceActionOptions)
159179

160180
##### `inputsFromDeployedStack`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStep.property.inputsFromDeployedStack"></a>
161181

182+
```typescript
183+
public readonly inputsFromDeployedStack: any[];
184+
```
185+
162186
- *Type:* `any`[]
163187

164188
---
165189

166190
##### `stateMachine`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStep.property.stateMachine"></a>
167191

192+
```typescript
193+
public readonly stateMachine: StateMachine;
194+
```
195+
168196
- *Type:* [`@aws-cdk/aws-stepfunctions.StateMachine`](#@aws-cdk/aws-stepfunctions.StateMachine)
169197

170198
---

package.json

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

test/unit/__snapshots__/orchestrator.test.ts.snap

Lines changed: 27 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)