deploy-vir 0.0.1 → 0.0.2
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 +43 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,3 +11,46 @@ npm i -D deploy-vir
|
|
|
11
11
|
## Setup
|
|
12
12
|
|
|
13
13
|
Add a TypeScript or JavaScript config file somewhere in your repo. Its default export should be your config:
|
|
14
|
+
|
|
15
|
+
<!-- example-link: src/readme-examples/config.example.ts -->
|
|
16
|
+
|
|
17
|
+
```TypeScript
|
|
18
|
+
import {defineDeployVirConfig, NotificationTarget} from 'deploy-vir';
|
|
19
|
+
|
|
20
|
+
export default defineDeployVirConfig({
|
|
21
|
+
repos: [
|
|
22
|
+
{
|
|
23
|
+
/** This does not need to match the actual repo name. */
|
|
24
|
+
name: 'whatever',
|
|
25
|
+
girUrl: 'git@github.com:electrovir/deploy-vir.git',
|
|
26
|
+
deploys: [
|
|
27
|
+
{
|
|
28
|
+
deployName: 'staging',
|
|
29
|
+
fromBranch: 'dev',
|
|
30
|
+
toBranch: 'staging',
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
deployName: 'prod',
|
|
34
|
+
fromBranch: 'staging',
|
|
35
|
+
toBranch: 'prod',
|
|
36
|
+
},
|
|
37
|
+
],
|
|
38
|
+
},
|
|
39
|
+
],
|
|
40
|
+
notifications: [
|
|
41
|
+
{
|
|
42
|
+
target: NotificationTarget.Slack,
|
|
43
|
+
webhookUrl: 'https://hooks.slack.com/services/X/X/X',
|
|
44
|
+
channelName: '#deploys',
|
|
45
|
+
},
|
|
46
|
+
],
|
|
47
|
+
});
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Running
|
|
51
|
+
|
|
52
|
+
Then just run the CLI:
|
|
53
|
+
|
|
54
|
+
```sh
|
|
55
|
+
npx deploy-vir <path-to-config> <repo-name-to-deploy> <deploy-name-to-deploy>
|
|
56
|
+
```
|