Skip to content

Commit

Permalink
docs: auto add changelogs (#6981)
Browse files Browse the repository at this point in the history
  • Loading branch information
WojtekTheWebDev authored Oct 24, 2023
1 parent fe5e958 commit 291d3d4
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 4 deletions.
1 change: 0 additions & 1 deletion docs/content/3.middleware/4.reference/change-log.md

This file was deleted.

89 changes: 89 additions & 0 deletions docs/content/3.middleware/4.reference/change-log.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Change log

## 3.6.1

### Patch Changes

- 3335b9b48: `getApiClient` helper returns now ApiClient interface

Usage:

```typescript
const sapcc = context.getApiClient<Api, Config, Client>("sapcc");
// typeof sapcc === ApiClient<Api, Config, Client>
```

## 3.6.0

### Minor Changes

- 1caa56efb: Add orchestration possibility by receiving loaded integrations from `context`
- 1caa56efb: Extend `IntegrationContext` type with `MiddlewareContext`
- 1caa56efb: Add new interface: `ApiClient`

### Patch Changes

- 1caa56efb: Remove singleton app from createServer function

## 3.5.1

### Patch Changes

- f8a7893: Enhanced error handling in **getAxiosStatusCode** for greater reliability, reducing the risk of unexpected errors and crashes when retrieving status codes from Axios errors.

## 3.5.0

### Minor Changes

- 50a0cd7: Added HTTP `GET` method support. Divided dynamic route logic into smaller, unit-tested middlewares.

## 3.4.0

### Minor Changes

- e2ff011: The `extendApp` callback which can be registered in extensions is now asynchronous and can be awaited to perform necessary operations while building the app.

## 3.3.1

### Patch Changes

- 5df8936: Fixed error objects detection

## 3.3.0

### Minor Changes

- 93e7c7c: Added possibility to pass API methods to createApiClient both as a plain object and a factory.

## 3.2.1

### Patch Changes

- Removed terser from the build process

## 3.2.0

### Features

- expose integration methods inside extensions context
- make integration name available within the `extendApp` extension method

## 3.1.0

### Features

- add configurable error handler

## 3.0.1

### Bug Fixes

- all 4xx error code respond with error not just generic message (#6)

## 3.0.0

This release decoupled the middleware from the core.

### Chores

- stable release.
1 change: 0 additions & 1 deletion docs/content/4.sdk/5.reference/change-log.md

This file was deleted.

13 changes: 13 additions & 0 deletions docs/content/4.sdk/5.reference/change-log.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Change log

## 1.1.1

### Patch Changes

- fix: prevent registering the same event multiple times

## 1.1.0

### Minor Changes

- Added handling of connectors implemented as proxy objects
5 changes: 4 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
"preview": "nuxt preview",
"api-extract": "cd ../ && yarn build && cd docs/ && yarn middleware-ref && yarn sdk-ref",
"middleware-ref": "cd ../packages/middleware && api-extractor run --local",
"sdk-ref": "cd ../packages/sdk && api-extractor run --local"
"sdk-ref": "cd ../packages/sdk && api-extractor run --local",
"add-changelogs:middleware": "cp ../packages/middleware/CHANGELOG.md ./content/3.middleware/4.reference/change-log.md",
"add-changelogs:sdk": "cp ../packages/sdk/CHANGELOG.md ./content/4.sdk/5.reference/change-log.md",
"add-changelogs": "yarn add-changelogs:middleware && yarn add-changelogs:sdk"
},
"devDependencies": {
"@microsoft/api-documenter": "^7.13.30",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"lint": "lerna run lint",
"changesets:version": "yarn changeset version && YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install && yarn prepare:docs",
"changesets:publish": "yarn build && yarn changeset publish",
"prepare:docs": "cd docs && yarn install && yarn api-extract"
"prepare:docs": "cd docs && yarn install && yarn api-extract && yarn add-changelogs"
},
"devDependencies": {
"@babel/core": "^7.10.5",
Expand Down

0 comments on commit 291d3d4

Please sign in to comment.