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.
Files changed (3) hide show
  1. package/README.md +28 -18
  2. package/ROADMAP.md +26 -53
  3. 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
- | Feature | Status | Notes |
98
- |--|--|--|
99
- | Mapping-based resolution | βœ… Implemented | |
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
- 🧭 Planned features:
234
+ We're continuously improving Envilder based on community feedback. Upcoming features include:
224
235
 
225
- - πŸ” Drift detection (`--check`)
226
- - 🧠 Auto-discovery (`--auto`)
227
- - πŸ“¨ Slack/Webhook notifications
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
- πŸ‘‰ See full [ROADMAP.md](./ROADMAP.md)
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
- ## βœ… Current Features
7
-
8
- - Map-based secret resolution via `param-map.json`
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
- ## 🚧 Planned Improvements
18
-
19
- ### πŸ”Ή Usability & Visibility
20
-
21
- - [ ] πŸ” **Auto-discovery mode** (`--auto`) for fetching all parameters with a given prefix
22
- - [ ] ✍️ **Tutorial repo** showing full example with GitHub Actions
23
- - [x] πŸ›οΈ **Official GitHub Action** (in Marketplace)
24
-
25
- ### πŸ”Ή Dev Experience & Adoption
26
-
27
- - [ ] βœ… **Check mode** (`--check`) to validate SSM vs existing `.env` and fail CI if out-of-sync
28
- - [ ] πŸ“ **Onboarding doc** for new teams (how to set up param-map, profiles, best practices)
29
-
30
- ### πŸ”Ή Advanced Features
31
-
32
- - [ ] ↩️ **Push mode** (`--push`) to push local `.env` back to AWS SSM
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
- ## πŸ§ͺ Long-term Ideas (Open to Feedback)
31
+ ## πŸ™Œ Contribute or Suggest Ideas
40
32
 
41
- - [ ] πŸ“ Support hierarchical `param-map.json` per environment
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
- ## Feature Status
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
- | Feature | Status | Notes |
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!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "envilder",
3
- "version": "0.7.0",
3
+ "version": "0.7.1",
4
4
  "description": "A CLI that securely centralizes your environment variables from AWS SSM as a single source of truth",
5
5
  "main": "./lib/apps/cli/Index.js",
6
6
  "bin": {