envilder 0.7.0 β 0.7.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.
- package/README.md +28 -18
- package/ROADMAP.md +26 -53
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -70,7 +70,6 @@ onboarding and CI/CD workflows.
|
|
|
70
70
|
- [β
How Envilder makes life easier](#-how-envilder-makes-life-easier)
|
|
71
71
|
- [π Table of Contents](#-table-of-contents)
|
|
72
72
|
- [βοΈ Features](#οΈ-features)
|
|
73
|
-
- [π§± Feature Status](#-feature-status)
|
|
74
73
|
- [πΎ Installation](#-installation)
|
|
75
74
|
- [π Quick Start](#-quick-start)
|
|
76
75
|
- [π₯ Video Demonstration](#-video-demonstration)
|
|
@@ -94,17 +93,9 @@ onboarding and CI/CD workflows.
|
|
|
94
93
|
|
|
95
94
|
### π§± Feature Status
|
|
96
95
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
| `.env` file generation | β
Implemented | |
|
|
101
|
-
| AWS profile support | β
Implemented | `--profile` flag |
|
|
102
|
-
| Import/push mode (`--push`) | β
Implemented | |
|
|
103
|
-
| Auto-discovery (`--auto`) | β Planned | Detect keys based on env |
|
|
104
|
-
| Check/sync mode (`--check`) | β Planned | Diff local vs remote |
|
|
105
|
-
| Webhook/Slack notification | β Planned | On push/pull events |
|
|
106
|
-
| Hierarchical mapping | β Not yet | Flat mapping only |
|
|
107
|
-
| Plugin system | β Not yet | SSM is the only backend (for now) |
|
|
96
|
+
- π€ **GitHub Action** β [Integrate directly in CI/CD workflows](./github-action/README.md)
|
|
97
|
+
- π€ **Push & Pull** β Bidirectional sync between local `.env` and AWS SSM
|
|
98
|
+
- π― **AWS Profile support** β Use `--profile` flag for multi-account setups
|
|
108
99
|
|
|
109
100
|
---
|
|
110
101
|
|
|
@@ -126,6 +117,26 @@ pnpm add -g envilder
|
|
|
126
117
|
> - [Setting up AWS CLI credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html)
|
|
127
118
|
> - [IAM permissions for SSM](https://docs.aws.amazon.com/systems-manager/latest/userguide/setup-instance-profile.html)
|
|
128
119
|
|
|
120
|
+
### π€ GitHub Action
|
|
121
|
+
|
|
122
|
+
Use Envilder directly in your CI/CD workflows with our official GitHub Action:
|
|
123
|
+
|
|
124
|
+
```yaml
|
|
125
|
+
- name: Configure AWS Credentials
|
|
126
|
+
uses: aws-actions/configure-aws-credentials@v5
|
|
127
|
+
with:
|
|
128
|
+
role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
|
|
129
|
+
aws-region: us-east-1
|
|
130
|
+
|
|
131
|
+
- name: Pull secrets from AWS SSM
|
|
132
|
+
uses: macalbert/envilder/github-action@v1
|
|
133
|
+
with:
|
|
134
|
+
map-file: param-map.json
|
|
135
|
+
env-file: .env
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
π **[View full GitHub Action documentation](./github-action/README.md)**
|
|
139
|
+
|
|
129
140
|
---
|
|
130
141
|
|
|
131
142
|
## π Quick Start
|
|
@@ -220,14 +231,13 @@ A: Yes, licensed under MIT.
|
|
|
220
231
|
|
|
221
232
|
## π Roadmap
|
|
222
233
|
|
|
223
|
-
|
|
234
|
+
We're continuously improving Envilder based on community feedback. Upcoming features include:
|
|
224
235
|
|
|
225
|
-
-
|
|
226
|
-
-
|
|
227
|
-
-
|
|
228
|
-
- π Plugin system (Vault, Secrets Manager, etc.)
|
|
236
|
+
- π **Multi-backend support** (Azure Key Vault, HashiCorp Vault, etc.)
|
|
237
|
+
- π **Check/sync mode** for drift detection
|
|
238
|
+
- π§ **Auto-discovery** for bulk parameter fetching
|
|
229
239
|
|
|
230
|
-
π
|
|
240
|
+
π **[View full roadmap with priorities](./ROADMAP.md)**
|
|
231
241
|
|
|
232
242
|
---
|
|
233
243
|
|
package/ROADMAP.md
CHANGED
|
@@ -3,65 +3,38 @@
|
|
|
3
3
|
Envilder aims to be the simplest, most reliable way to generate `.env` files from AWS SSM Parameter Store
|
|
4
4
|
β for both local development and CI/CD pipelines.
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
- Outputs clean `.env` files
|
|
10
|
-
- Supports AWS profiles (`AWS_PROFILE`)
|
|
11
|
-
- Compatible with SecureString and plain parameters
|
|
12
|
-
- CLI-first, lightweight
|
|
13
|
-
- πΈ **Demo GIF/video** showing the tool in action (terminal + env + app)
|
|
6
|
+
> **Note:** This roadmap contains ideas and potential features based on initial vision and community feedback.
|
|
7
|
+
> Not all features are guaranteed to be implemented. Priorities may change based on user needs, feedback,
|
|
8
|
+
> and real-world usage patterns. Your input mattersβfeel free to share your thoughts and suggestions!
|
|
14
9
|
|
|
15
10
|
---
|
|
16
11
|
|
|
17
|
-
##
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
- [ ] π **Optional webhook/Slack notifier** on secret sync (for audit/logging)
|
|
34
|
-
- [ ] π **Web-based interactive demo** (optional) to test mappings live
|
|
35
|
-
- [ ] π§ **Awesome list submissions** and community templates
|
|
12
|
+
## Feature Status & Roadmap
|
|
13
|
+
|
|
14
|
+
| Feature | Status | Priority | Notes |
|
|
15
|
+
|---------|--------|----------|-------|
|
|
16
|
+
| **Mapping-based resolution** | β
Implemented | - | Core functionality |
|
|
17
|
+
| **`.env` file generation** | β
Implemented | - | Core functionality |
|
|
18
|
+
| **AWS profile support** | β
Implemented | - | `--profile` flag |
|
|
19
|
+
| **Push mode** (`--push`) | β
Implemented | - | [Guide](./docs/push-command.md) |
|
|
20
|
+
| **GitHub Action** | β
Implemented | - | [Documentation](./github-action/README.md) |
|
|
21
|
+
| **Onboarding documentation** | β
Implemented | - | [Setup guide](./docs/requirements-installation.md) |
|
|
22
|
+
| **Plugin system / Multi-backend** | β Planned | π₯ Next | Starting with Azure Key Vault support |
|
|
23
|
+
| **Check/sync mode** (`--check`) | β Planned | High | Validate SSM vs `.env`, fail CI if out-of-sync |
|
|
24
|
+
| **Auto-discovery mode** (`--auto`) | β Planned | Medium | Fetch all parameters with a given prefix |
|
|
25
|
+
| **Webhook/Slack notifications** | β Planned | Low | Notify on secret sync for audit/logging |
|
|
26
|
+
| **Hierarchical mapping** | β Future | Low | Per-environment `param-map.json` |
|
|
27
|
+
| **Web-based demo** | β Future | Low | Interactive mapping tester |
|
|
36
28
|
|
|
37
29
|
---
|
|
38
30
|
|
|
39
|
-
##
|
|
31
|
+
## π Contribute or Suggest Ideas
|
|
40
32
|
|
|
41
|
-
|
|
42
|
-
- [ ] 𧬠Plugin system for custom resolvers (e.g., secrets from other providers)
|
|
43
|
-
|
|
44
|
-
---
|
|
45
|
-
|
|
46
|
-
## π Contribute or suggest ideas
|
|
47
|
-
|
|
48
|
-
If youβve faced similar problems or want to help improve this tool, feel free to open an issue, submit a PR
|
|
49
|
-
or reach out.
|
|
50
|
-
Every bit of feedback helps make this tool better for the community.
|
|
51
|
-
|
|
52
|
-
---
|
|
33
|
+
If you've faced similar problems or want to help improve this tool, feel free to:
|
|
53
34
|
|
|
54
|
-
|
|
35
|
+
- π [Open an issue](https://github.com/macalbert/envilder/issues/new)
|
|
36
|
+
- π‘ Share feature ideas and use cases
|
|
37
|
+
- π§ Submit a Pull Request
|
|
38
|
+
- π¬ Provide feedback on planned features
|
|
55
39
|
|
|
56
|
-
|
|
57
|
-
|--------------------------------|---------------|-------|
|
|
58
|
-
| Push mode (`--push`) | β
Implemented | |
|
|
59
|
-
| Mapping-based secret resolution| β
Implemented | |
|
|
60
|
-
| .env file generation | β
Implemented | |
|
|
61
|
-
| AWS profile support | β
Implemented | |
|
|
62
|
-
| GitHub Action | β
Implemented | Available as composite action |
|
|
63
|
-
| Auto-discovery mode (`--auto`) | β Not implemented | Planned |
|
|
64
|
-
| Check/sync mode (`--check`) | β Not implemented | Planned |
|
|
65
|
-
| Webhook/Slack notification | β Not implemented | Planned |
|
|
66
|
-
| Hierarchical mapping | β Not implemented | Only flat JSON mapping supported |
|
|
67
|
-
| Plugin system | β Not implemented | Only AWS SSM supported |
|
|
40
|
+
Every bit of feedback helps make this tool better for the community!
|