infra-foundry 1.0.2 → 1.0.4

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 (2) hide show
  1. package/README.md +6 -90
  2. package/package.json +14 -8
package/README.md CHANGED
@@ -1,10 +1,9 @@
1
1
  # 🏗️ Infra Foundry
2
2
 
3
- A platform-agnostic cloud infrastructure components library for modern applications. Built with TypeScript and Pulumi, Infra Foundry provides reusable, composable infrastructure components that work across AWS, Cloudflare, and other cloud providers.
4
-
5
- ## 📊 Version
3
+ [![npm version](https://img.shields.io/npm/v/infra-foundry.svg)](https://www.npmjs.com/package/infra-foundry)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
5
 
7
- Current version: **0.3.0**
6
+ A platform-agnostic cloud infrastructure components library for modern applications. Built with TypeScript and Pulumi, Infra Foundry provides reusable, composable infrastructure components that work across AWS, Cloudflare, and other cloud providers.
8
7
 
9
8
  ## ✨ Features
10
9
 
@@ -24,17 +23,9 @@ Current version: **0.3.0**
24
23
  - In your infra project repo
25
24
 
26
25
  ```bash
27
- # Install directly from GitHub
28
- yarn add git+ssh://git@github.com/0xhssn/infra-foundry.git
29
-
30
- # or add as dependency in package.json
31
- "dependencies": {
32
- ...
33
- "infra-foundry": "git+ssh://git@github.com/0xhssn/infra-foundry.git",
34
- ...
35
- }
36
- # and then install
37
- yarn install
26
+ npm install infra-foundry
27
+ # or
28
+ yarn add infra-foundry
38
29
  ```
39
30
 
40
31
  - Create a Pulumi Organisation via Pulumi console
@@ -86,81 +77,6 @@ src/
86
77
  └── utils/ # Shared utilities
87
78
  ```
88
79
 
89
- ## 🛠️ Development
90
-
91
- ### Prerequisites
92
-
93
- - Node.js >= 20.0.0
94
- - TypeScript >= 5.0.0
95
- - Pulumi CLI
96
-
97
- ### Setup
98
-
99
- ```bash
100
- # Clone the repository
101
- git clone https://github.com/0xhssn/infra-foundry.git
102
- cd infra-foundry
103
-
104
- # Install dependencies
105
- yarn install
106
-
107
- # Build the project
108
- yarn build
109
- ```
110
-
111
- ### Code Quality
112
-
113
- ```bash
114
- # Run linting
115
- yarn lint
116
-
117
- # Fix linting issues
118
- yarn lint:fix
119
-
120
- # Format code
121
- yarn format
122
-
123
- # Check formatting
124
- yarn format:check
125
- ```
126
-
127
- ## 🚀 Release Automation
128
-
129
- Infra Foundry uses [semantic-release](https://semantic-release.gitbook.io/) for fully automated version management and package publishing. Versions are determined automatically based on commit messages following [Conventional Commits](https://www.conventionalcommits.org/).
130
-
131
- ### How It Works
132
-
133
- 1. **Commit Analysis**: Commits are analyzed to determine the next version bump
134
- 2. **Changelog Generation**: CHANGELOG.md is automatically updated
135
- 3. **NPM Publishing**: Package is published to npm registry
136
- 4. **GitHub Release**: A GitHub release is created with release notes
137
-
138
- ### Release Channels
139
-
140
- | Branch | Channel | Example Version |
141
- | ------- | ----------- | --------------- |
142
- | `main` | Stable | `1.2.3` |
143
- | `beta` | Pre-release | `1.2.3-beta.1` |
144
- | `alpha` | Pre-release | `1.2.3-alpha.1` |
145
-
146
- ### Setting Up NPM_TOKEN
147
-
148
- To enable automated npm publishing, add the `NPM_TOKEN` secret to your repository:
149
-
150
- 1. Go to [npmjs.com](https://www.npmjs.com/) → Access Tokens
151
- 2. Generate New Token → Select "Automation" type
152
- 3. Copy the token
153
- 4. In GitHub: Repository → Settings → Secrets and variables → Actions
154
- 5. Add new secret: Name = `NPM_TOKEN`, Value = your token
155
-
156
- ### Version Bump Rules
157
-
158
- | Commit Type | Example | Version Bump |
159
- | --------------- | ------------------- | ------------- |
160
- | Breaking change | `feat(s3)!: ...` | Major (1.0.0) |
161
- | Feature | `feat(ecs): ...` | Minor (0.1.0) |
162
- | Fix | `fix(amplify): ...` | Patch (0.0.1) |
163
-
164
80
  ## 🤝 Contributing
165
81
 
166
82
  We welcome contributions! Please see our [Contributing Guidelines](./CONTRIBUTING.md) for details.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "infra-foundry",
3
- "version": "1.0.2",
4
- "description": "🌪️ Cloud infrastructure components library for modern applications",
3
+ "version": "1.0.4",
4
+ "description": "Production-ready cloud infrastructure components for modern applications, built with TypeScript and Pulumi.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "files": [
@@ -10,14 +10,20 @@
10
10
  "LICENSE"
11
11
  ],
12
12
  "keywords": [
13
- "cloud",
14
- "infrastructure",
15
13
  "pulumi",
16
14
  "aws",
17
15
  "cloudflare",
18
- "components",
19
- "iac"
16
+ "infrastructure",
17
+ "iac",
18
+ "devops",
19
+ "typescript",
20
+ "cloud",
21
+ "ecs",
22
+ "s3",
23
+ "vpc",
24
+ "route53"
20
25
  ],
26
+ "author": "Hamza Hassan <hassanhamza0101@gmail.com> (https://linkedin.com/in/hhssnn)",
21
27
  "contributors": [
22
28
  {
23
29
  "name": "Hamza Hassan",
@@ -26,9 +32,9 @@
26
32
  ],
27
33
  "repository": {
28
34
  "type": "git",
29
- "url": "git+ssh://git@github.com/0xhssn/infra-foundry.git"
35
+ "url": "git+https://github.com/0xhssn/infra-foundry.git"
30
36
  },
31
- "homepage": "https://github.com/0xhssn/infra-foundry#readme",
37
+ "homepage": "https://github.com/0xhssn/infra-foundry",
32
38
  "bugs": {
33
39
  "url": "https://github.com/0xhssn/infra-foundry/issues"
34
40
  },