1
1
<div align =" center " >
2
- <img src =" https://user-images.githubusercontent.com/83855174/200222357-3e74436c-36be-41f9-8da6-519052db15bf.png " alt =" owlly banner" width =" 100% " />
2
+ <img src =" https://user-images.githubusercontent.com/83855174/200222357-3e74436c-36be-41f9-8da6-519052db15bf.png " alt =" banner " width =" 100% " />
3
3
</div >
4
4
5
5
# 🦉 Owlly
6
6
7
- <img src =" https://img.shields.io/badge/version-v0.1.3 -red " alt =" version 0.1.3 " />
7
+ <img src =" https://img.shields.io/badge/version-v0.1.4 -red " alt =" version 0.1.4 " />
8
8
9
9
A file-based .env change notifier for your slack team.
10
10
11
- <img src =" https://user-images.githubusercontent.com/83855174/198875029-f20bba16-66e6-48d2-9d06-9feaea8fe175 .gif " height = " 400px " alt =" owlly banner " width =" 100% " />
11
+ <img src =" https://user-images.githubusercontent.com/83855174/200312951-eec9e105-1772-4afa-b0ae-233d5fbda28d .gif " alt =" demo " width =" 100% " />
12
12
13
- ## Contents
13
+ ## Table of Contents
14
14
15
15
- [ Owlly] ( #owlly )
16
16
- [ Features] ( #features )
@@ -23,7 +23,7 @@ A file-based .env change notifier for your slack team.
23
23
## Features
24
24
25
25
- Auto-sync .env file changes
26
- - Watch multiple .env files: .env, .env.test, .env.development, .env.production
26
+ - Watch multiple .env files
27
27
- Auto-post the update to slack channel as attachment
28
28
- Basic metadata supported: timestamp, .env directory
29
29
- Cross platform supported: Windows, Mac OS(intel, m1 chip)
@@ -48,6 +48,23 @@ Or, simply download binaries from [release](https://github.com/asunlabs/owlly/re
48
48
49
49
## Prerequisite
50
50
51
+ ### Assumption
52
+
53
+ Owlly will check if below files exist in your project root and sync if exist.
54
+
55
+ ``` go
56
+ envList = []string {
57
+ " .env" ,
58
+ " .env.test" ,
59
+ " .env.development" ,
60
+ " .env.production" ,
61
+ " .env.dev" ,
62
+ " .env.prod" ,
63
+ }
64
+ ```
65
+
66
+ ### Slack
67
+
51
68
In order to use Owlly, you have to
52
69
53
70
1 . Create a slack bot
@@ -66,26 +83,20 @@ SLACK_CHANNEL_ID="channel-id-here"
66
83
67
84
## Usage
68
85
69
- 1 . Make sure you have all .env files in project root
70
-
71
- ```
72
- .env, .env.test, .env.production, .env.development
73
- ```
74
-
75
- 2 . Update .env files as you wish.
86
+ 1 . Update .env files as you wish.
76
87
77
88
``` sh
78
89
FOO=" bar"
79
90
```
80
91
81
- 3 . Once done, set OWLLY_DONE variable in your .env. This variable will be a key for Owlly to know if your update is done.
92
+ 2 . Once done, set OWLLY_DONE variable in your .env. This variable will be a key for Owlly to know if your update is done.
82
93
83
94
``` sh
84
95
# length of OWLLY_DONE > 0 ? send a DM : do nothing
85
96
OWLLY_DONE=" true"
86
97
```
87
98
88
- 4 . Run Owlly to watch .env changes.
99
+ 3 . Run Owlly
89
100
90
101
``` sh
91
102
# if you cloned a repo,
@@ -97,9 +108,9 @@ go run owlly.go
97
108
./owlly-for-mac-m1
98
109
```
99
110
100
- Check your slack channel if the message is sent. Result will look like below.
111
+ Check your slack channel if the message is sent. Result will look like below.
101
112
102
- <img src =" hhttps ://user-images.githubusercontent.com/83855174/198875580-ba52d111-907a-43bf-8937-23b5558378a4 .png" height =" 400px " alt =" owlly banner " width =" 100% " />
113
+ <img src =" https ://user-images.githubusercontent.com/83855174/200310048-48d918c4-2478-4d60-a68a-906202b1a8db .png" height =" 400px " alt =" owlly banner " width =" 100% " />
103
114
104
115
** Note**
105
116
0 commit comments