Skip to content

Commit 308de24

Browse files
Andrea-ScuderiAndrea Scuderi
andauthored
Improve Readme and Add Noora to CLI
* Improve Readme * Update costs section * Add cloudwatch * Fix icons in README * Add Noora * Update Text Logo * Update Breeze with Noora * Update GenerateLambdaAPI Readme * Fix tests * Fix Makefile and tests --------- Co-authored-by: Andrea Scuderi <[email protected]>
1 parent 1ae690b commit 308de24

23 files changed

+581
-291
lines changed

Configs/MyAwesomeAPI.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
service: swift-breeze-rest-my-awesome-api
2+
awsRegion: us-east-1
3+
swiftVersion: 6.1.2
4+
swiftConfiguration: release
5+
packageName: BreezeMyAwesomeAPI
6+
buildPath: build
7+
cors: false
8+
breezeLambdaAPI:
9+
targetName: MyAwesomeAPI
10+
itemCodable: Item
11+
itemKey: itemKey
12+
httpAPIPath: /my-awesome-items
13+
dynamoDBTableNamePrefix: items

Configs/MyAwesomeGithubWebhook.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
service: swift-breeze-myawesome-github-webhook
2+
awsRegion: us-east-1
3+
swiftVersion: 6.1.2
4+
swiftConfiguration: release
5+
packageName: BreezeMyAwesomeGitHubWebHook
6+
buildPath: build
7+
cors: false
8+
breezeGithubWebhook:
9+
targetName: GitHubWebHook
10+
httpPath: /myawesome-github-webhook
11+
secret: ${ssm:/dev/swift-webhook/webhook_secret}

Configs/MyAwesomeWebhook.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
service: swift-breeze-myawewesome-webhook
2+
awsRegion: us-east-1
3+
swiftVersion: 6.1.2
4+
swiftConfiguration: release
5+
packageName: BreezeMyAwesomeWebhook
6+
buildPath: build
7+
cors: false
8+
breezeWebhook:
9+
targetName: WebHook
10+
httpPath: /myawewesome-webhook

Docs/GenerateLambdaAPI.md

Lines changed: 31 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -179,72 +179,45 @@ If you don't want to use a custom authorizer, remove the `authorizer` section.
179179
The following command will run using the example configuration file and generate the deployment files in the `.build/temp` folder.
180180

181181
```bash
182-
swift run breeze -c Sources/BreezeCommand/Resources/breeze.yml -t .build/temp
182+
swift run breeze generate-lambda-api -c Sources/BreezeCommand/Resources/breeze.yml -t .build/temp
183183
```
184184

185185
output:
186186

187187
```bash
188-
⚙️ Loading configuration file
189188
190-
/Users/andreascuderi/Documents/workspace/Breeze/Sources/BreezeCommand/Resources/breeze.yml
189+
190+
\ | /
191+
| / -----< -
192+
----< - | \
193+
/ | \ /
194+
░▒░░░░ \ ----< -
195+
░░▒░░░░▒░░ ->-- / \
196+
░▒░░▒▒░▒░░▒░ /
197+
░░░▒░░▓█░▒▒░░░
198+
░▒▒░▒████░░░░░
199+
▒░░░░░█▓░▒░▒▒░ ░████████
200+
░░░░█░▒░░▒░░ ░██ ░██
201+
░░█░▒░▒░░▒ ░██ ░██ ░██████ ░████████ ░████████ ░█████████ ░████████
202+
█░░░░░▒ ░████████ ░██ ░██ ░██ ░██ ░███ ░██
203+
▓█ ░██ ░██ ░██████ ░████████ ░████████ ░███ ░████████
204+
▓█ ░██ ░██ ░██ ░██ ░██ ░██ ░███ ░██
205+
██ ░█████████ ░██ ░██ ░████████ ░████████ ░█████████ ░████████
206+
191207
192-
service: swift-breeze-rest-item-api
193-
awsRegion: us-east-1
194-
swiftVersion: 5.10.1
195-
swiftConfiguration: release
196-
packageName: BreezeItemAPI
197-
buildPath: build
198-
cors: false
199-
breezeLambdaAPI:
200-
targetName: ItemAPI
201-
itemCodable: Item
202-
itemKey: itemKey
203-
httpAPIPath: /items
204-
dynamoDBTableNamePrefix: items
205-
206-
🔎 Verifing target path
207-
208-
🧹 .build/temp
209-
210-
✅ Target path ready!
211-
212-
📁 Generating project from template
213-
214-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/SwiftPackage/Package.swift
215-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/SwiftPackage/Sources/SwiftTarget/main.swift
216-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/Dockerfile
217-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/remove.sh
218-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/.gitignore
219-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/deploy.sh
220-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/update.sh
221-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/Makefile
222-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/README.md
223-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/build.sh
224-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/swagger.json
225-
🛫 .build/temp/SwiftPackage/Sources/SwiftTarget
226-
🛬 .build/temp/SwiftPackage/Sources/ItemAPI
227-
🛫 .build/temp/SwiftPackage
228-
🛬 .build/temp/BreezeItemAPI
229-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/serverless.yml
230-
📄 /Users/andreascuderi/Documents/workspace/Breeze/.build/temp/serverless-x86_64.yml
231-
232-
✅ Project is ready at target-path
233-
234-
.build/temp
235-
236-
🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵
237-
🎵💨💨💨💨💨💨🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵
238-
🎵💨🎵🎵🎵🎵🎵💨🎵💨💨💨💨💨🎵🎵💨💨💨💨💨💨🎵💨💨💨💨💨💨🎵💨💨💨💨💨💨🎵💨💨💨💨💨💨🎵
239-
🎵💨🎵🎵🎵🎵🎵💨🎵💨🎵🎵🎵🎵💨🎵💨🎵🎵🎵🎵🎵🎵💨🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵💨🎵🎵💨🎵🎵🎵🎵🎵🎵
240-
🎵💨💨💨💨💨💨🎵🎵💨🎵🎵🎵🎵💨🎵💨💨💨💨💨🎵🎵💨💨💨💨💨🎵🎵🎵🎵🎵💨🎵🎵🎵💨💨💨💨💨🎵🎵
241-
🎵💨🎵🎵🎵🎵🎵💨🎵💨💨💨💨💨🎵🎵💨🎵🎵🎵🎵🎵🎵💨🎵🎵🎵🎵🎵🎵🎵🎵💨🎵🎵🎵🎵💨🎵🎵🎵🎵🎵🎵
242-
🎵💨🎵🎵🎵🎵🎵💨🎵💨🎵🎵🎵💨🎵🎵💨🎵🎵🎵🎵🎵🎵💨🎵🎵🎵🎵🎵🎵🎵💨🎵🎵🎵🎵🎵💨🎵🎵🎵🎵🎵🎵
243-
🎵💨💨💨💨💨💨🎵🎵💨🎵🎵🎵🎵💨🎵💨💨💨💨💨💨🎵💨💨💨💨💨💨🎵💨💨💨💨💨💨🎵💨💨💨💨💨💨🎵
244-
🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵🎵
245-
246-
💨 Use the following commands to build & deploy
247208
209+
ℹ︎ Loading configuration
210+
from: ~/Documents/workspace/Breeze/Sources/BreezeCommand/Resources/breeze.yml
211+
✔︎ Configuration loaded [0.0s]
212+
✔︎ Target path is valid
213+
✔︎ Project genereration succeeded
214+
215+
✔ Success
216+
Project is ready at path: .build/temp
217+
218+
i Info
219+
Use the following commands to build & deploy:
220+
248221
cd .build/temp
249222
./build.sh
250223
./deploy.sh

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ EXAMPLE_PATH = ./Examples/ItemAPI
33
EXAMPLE_GITHUB_WEBHOOK_PATH = ./Examples/GitHubWebhook
44
EXAMPLE_WEBHOOK_PATH = ./Examples/Webhook
55
BUILD_TEMP = .build/temp
6-
SWIFT_VERSION= 5.10
6+
SWIFT_VERSION= 6.1.2
77
OS = ubuntu
88
DOCKER_TAG = breeze:$(SWIFT_VERSION)-$(OS)
99
DOCKERFILE = docker/$(SWIFT_VERSION)/$(OS)/.

Package.resolved

Lines changed: 38 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Package.swift

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// swift-tools-version: 5.7
1+
// swift-tools-version: 5.8.1
22
// The swift-tools-version declares the minimum version of Swift required to build this package.
33

44
import PackageDescription
@@ -18,14 +18,16 @@ let package = Package(
1818
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.0.0"),
1919
.package(url: "https://github.com/stencilproject/Stencil.git", from: "0.15.1"),
2020
.package(url: "https://github.com/swift-serverless/swift-sls-adapter", from: "0.2.1"),
21+
.package(url: "https://github.com/tuist/Noora.git", from: "0.45.0")
2122
],
2223
targets: [
2324
.executableTarget(
2425
name: "BreezeCommand",
2526
dependencies: [
2627
.product(name: "ArgumentParser", package: "swift-argument-parser"),
2728
.product(name: "SLSAdapter", package: "swift-sls-adapter"),
28-
.product(name: "Stencil", package: "Stencil")
29+
.product(name: "Stencil", package: "Stencil"),
30+
.product(name: "Noora", package: "Noora")
2931
],
3032
resources: [.copy("Resources")]
3133
),

0 commit comments

Comments
 (0)