redkite 0.1.6 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
</h1>
|
|
4
4
|
|
|
5
5
|
<p align="center">
|
|
6
|
-
<a href="https://www.npmjs.com/package/redkite
|
|
7
|
-
<a href="https://www.npmjs.com/package/redkite
|
|
8
|
-
<a href="https://nodejs.org"><img alt="node" src="https://img.shields.io/node/v/redkite
|
|
9
|
-
<a href="./LICENSE"><img alt="license" src="https://img.shields.io/npm/l/redkite
|
|
6
|
+
<a href="https://www.npmjs.com/package/redkite"><img alt="npm version" src="https://img.shields.io/npm/v/redkite.svg"></a>
|
|
7
|
+
<a href="https://www.npmjs.com/package/redkite"><img alt="npm downloads" src="https://img.shields.io/npm/dm/redkite.svg"></a>
|
|
8
|
+
<a href="https://nodejs.org"><img alt="node" src="https://img.shields.io/node/v/redkite.svg"></a>
|
|
9
|
+
<a href="./LICENSE"><img alt="license" src="https://img.shields.io/npm/l/redkite.svg"></a>
|
|
10
10
|
</p>
|
|
11
11
|
|
|
12
12
|
<p align="center">
|
|
@@ -40,13 +40,13 @@ between deploys.
|
|
|
40
40
|
## Quick start
|
|
41
41
|
|
|
42
42
|
```sh
|
|
43
|
-
npm install redkite
|
|
43
|
+
npm install redkite
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
Add `redkite.config.ts` at the root of your project:
|
|
47
47
|
|
|
48
48
|
```ts
|
|
49
|
-
import { defineDeployment, nextApp, nodeApp, redis } from "redkite
|
|
49
|
+
import { defineDeployment, nextApp, nodeApp, redis } from "redkite";
|
|
50
50
|
|
|
51
51
|
export default defineDeployment({
|
|
52
52
|
project: "acme",
|
|
@@ -137,7 +137,7 @@ One file each, beside the deployment, named `redkite.<environment>.config.ts`:
|
|
|
137
137
|
|
|
138
138
|
```ts
|
|
139
139
|
// redkite.production.config.ts
|
|
140
|
-
import { defineEnvironment } from "redkite
|
|
140
|
+
import { defineEnvironment } from "redkite";
|
|
141
141
|
|
|
142
142
|
export default defineEnvironment({
|
|
143
143
|
branch: "main",
|
|
@@ -468,7 +468,7 @@ config that registers a step at the same point replaces it. That is how one is
|
|
|
468
468
|
turned off: put something there that does less.
|
|
469
469
|
|
|
470
470
|
```ts
|
|
471
|
-
import { defineStep } from "redkite
|
|
471
|
+
import { defineStep } from "redkite";
|
|
472
472
|
|
|
473
473
|
export default defineDeployment({
|
|
474
474
|
// ...
|
|
@@ -513,7 +513,7 @@ A migration is a step like any other. `migrate()` answers with one at
|
|
|
513
513
|
the old containers are still serving, and throws before anything retires.
|
|
514
514
|
|
|
515
515
|
```ts
|
|
516
|
-
import { migrate } from "redkite
|
|
516
|
+
import { migrate } from "redkite";
|
|
517
517
|
|
|
518
518
|
export default defineDeployment({
|
|
519
519
|
steps: [migrate({ app: "backend", command: "yarn db:migrate" })],
|
|
@@ -548,7 +548,7 @@ migrate({ app: "backend", command: "yarn db:migrate", network: "deployment" })
|
|
|
548
548
|
`attachment()` answers with the same flags for a step of your own:
|
|
549
549
|
|
|
550
550
|
```ts
|
|
551
|
-
import { attachment, defineStep } from "redkite
|
|
551
|
+
import { attachment, defineStep } from "redkite";
|
|
552
552
|
|
|
553
553
|
defineStep("swap:before:seed", async (built, context) => {
|
|
554
554
|
const image = built.apps.find((app) => app.name === "backend")?.builderTag;
|