Skip to content

Commit

Permalink
[automated commit] Bump docs to versions 2.8.0, 1.53.4
Browse files Browse the repository at this point in the history
  • Loading branch information
leorossi authored and github-actions[bot] committed Nov 4, 2024
1 parent 0655729 commit dcd7677
Show file tree
Hide file tree
Showing 190 changed files with 67 additions and 15 deletions.
3 changes: 2 additions & 1 deletion docs/packages/astro/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ See the [configuration](./configuration.md) page.
## API

- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
Expand Down
3 changes: 2 additions & 1 deletion docs/packages/next/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ See the [configuration](./configuration.md) page.
## API

- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/node/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,14 @@ See the [configuration](./configuration.md) page.
## API
- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
- **`platformatic.events.on('close')`**: This event is emitted when the process is being closed. A listener should be installed to perform a graceful close, which must finish in 10 seconds. If there is no listener, the process will be terminated by invoking `process.exit(0)`.
<Issues />
<Issues />
````
```

```
3 changes: 2 additions & 1 deletion docs/packages/remix/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ See the [configuration](./configuration.md) page.
## API

- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
Expand Down
3 changes: 2 additions & 1 deletion docs/packages/vite/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ See the [configuration](./configuration.md) page.
## API

- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
Expand Down
18 changes: 18 additions & 0 deletions docs/runtime/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ runtime. Each service object supports the following settings:
the microservice.
- **`useHttp`** (`boolean`) - The service will be started on a random HTTP port
on `127.0.0.1`, and exposed to the other services via that port, on default it is set to `false`. Set it to `true` if you are using [@fastify/express](https://github.com/fastify/fastify-express).
- **`workers`** (`number`) - The number of workers to start for this service. If the service is the entrypoint or if the runtime is running in development mode this value is ignored and hardcoded to `1`.

If this property is present, then the services will not be reordered according to the
`getBootstrapDependencies` function and they will be started in the order they are defined in
Expand All @@ -84,6 +85,23 @@ The Platformatic Runtime's entrypoint is a microservice that is exposed
publicly. This value must be the `ID` of a service defined via the `autoload` or
`services` configuration.

### `workers`

The default number of workers to start per each service. It can be overriden at service level.

This value is hardcoded to `1` if the runtime is running in development mode or when applying it to the entrypoint.

### `gracefulShutdown`

Configures the amount of milliseconds to wait before forcefully killing a service or the runtime.

The object supports the following settings:

- **`service`** (`number`) - The graceful shutdown timeout for a service.
- **`runtime`** (`number`) - The graceful shutdown timeout for the entire runtime.

For both the settings the default is `10000` (ten seconds).

### `watch`

An optional boolean, set to default `false`, indicating if hot reloading should
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ See the [configuration](./configuration.md) page.
## API

- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ See the [configuration](./configuration.md) page.
## API

- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,14 @@ See the [configuration](./configuration.md) page.
## API
- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
- **`platformatic.events.on('close')`**: This event is emitted when the process is being closed. A listener should be installed to perform a graceful close, which must finish in 10 seconds. If there is no listener, the process will be terminated by invoking `process.exit(0)`.
<Issues />
<Issues />
````
```

```
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ See the [configuration](./configuration.md) page.
## API

- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ See the [configuration](./configuration.md) page.
## API

- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible.
- **`platformatic.id`**: The id of the service.
- **`platformatic.serviceId`**: The id of the service.
- **`platformatic.workerId`**: The id of the service worker.
- **`platformatic.root`**: The root directory of the service.
- **`platformatic.basePath`**: The base path of the service in the composer.
- **`platformatic.logLevel`**: The log level configured for the service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ runtime. Each service object supports the following settings:
the microservice.
- **`useHttp`** (`boolean`) - The service will be started on a random HTTP port
on `127.0.0.1`, and exposed to the other services via that port, on default it is set to `false`. Set it to `true` if you are using [@fastify/express](https://github.com/fastify/fastify-express).
- **`workers`** (`number`) - The number of workers to start for this service. If the service is the entrypoint or if the runtime is running in development mode this value is ignored and hardcoded to `1`.

If this property is present, then the services will not be reordered according to the
`getBootstrapDependencies` function and they will be started in the order they are defined in
Expand All @@ -84,6 +85,23 @@ The Platformatic Runtime's entrypoint is a microservice that is exposed
publicly. This value must be the `ID` of a service defined via the `autoload` or
`services` configuration.

### `workers`

The default number of workers to start per each service. It can be overriden at service level.

This value is hardcoded to `1` if the runtime is running in development mode or when applying it to the entrypoint.

### `gracefulShutdown`

Configures the amount of milliseconds to wait before forcefully killing a service or the runtime.

The object supports the following settings:

- **`service`** (`number`) - The graceful shutdown timeout for a service.
- **`runtime`** (`number`) - The graceful shutdown timeout for the entire runtime.

For both the settings the default is `10000` (ten seconds).

### `watch`

An optional boolean, set to default `false`, indicating if hot reloading should
Expand Down
2 changes: 1 addition & 1 deletion versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[
"2.7.0",
"2.8.0",
"1.53.4"
]

0 comments on commit dcd7677

Please sign in to comment.