gen-env 0.2.0 → 0.2.1
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.
- checksums.yaml +4 -4
- data/README.md +13 -6
- data/lib/gen/env/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 750b5e7ac9d357a396ebae94c0ce940067423501
|
|
4
|
+
data.tar.gz: f999d70448165b9ceb54f263413fb3e2868e38a6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 33b14787ddbab577f6f9a4aab0bdc95e4ea98c0f6f5ce5465e27ca3a6c1923e0ef0707cbe72fd86310f695b23f2ad37fdf65d1c1ca7e14e9fa58f6724dbcc373
|
|
7
|
+
data.tar.gz: 9a56106be0b670f427d0d2d199507e1d9d9d4a9eaa1620d3587dd128c2c15e33ca7ffbaee6b2f6872f964491779cc0b7cabb272f2704de82a067f9205c24adbb
|
data/README.md
CHANGED
|
@@ -1,8 +1,16 @@
|
|
|
1
|
-
#
|
|
1
|
+
# gen-env
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
More than often, a typical java project requires you to manage multiple properties or env files across different environments. For example, local.env, sit.env, qa.env etc etc. And there are multiple problems managing these sort of environment files.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
#### Problems with multiple .properties file
|
|
6
|
+
|
|
7
|
+
1. No better mechanism of logically grouping multiple entries in .env file, other than developer's discipline. For example, order of individual configurations for database, load-balancer etc. can vary a lot from one environment to other.
|
|
8
|
+
2. It becomes difficult and cumbersome to find a single entry in all properties file and change it without juggling with your favorite editor's find and replace feature.
|
|
9
|
+
3. No way of testing if a particular variable is available in the corresponding .env / .properties file other than manually doing grep on the file. This can cause lots of surprises when you actually deploy an app in environment.
|
|
10
|
+
|
|
11
|
+
#### Solutions to above problems
|
|
12
|
+
1. A simple DSL that can logically group different configurations and produce the final env / property file in same order across multiple environment.
|
|
13
|
+
2. Rather than managing .env / .properties files in plain text files, an ability to write your .env / .properties in ruby language allows you to unit test your configuration files for presence or absense of particular key/value pair.
|
|
6
14
|
|
|
7
15
|
## Installation
|
|
8
16
|
|
|
@@ -22,17 +30,16 @@ Or install it yourself as:
|
|
|
22
30
|
|
|
23
31
|
## Usage
|
|
24
32
|
|
|
25
|
-
TODO: Write usage instructions here
|
|
26
33
|
|
|
27
34
|
## Development
|
|
28
35
|
|
|
29
|
-
After checking out the repo, run `
|
|
36
|
+
After checking out the repo, run `bundle install --path vendor/bundle` to install dependencies. Then, run `bundle exec rake spec` to run the tests.
|
|
30
37
|
|
|
31
38
|
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
|
32
39
|
|
|
33
40
|
## Contributing
|
|
34
41
|
|
|
35
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
|
42
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/davcdhanesh1/gen-env. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
36
43
|
|
|
37
44
|
|
|
38
45
|
## License
|
data/lib/gen/env/version.rb
CHANGED