Skip to content

Commit 0ae5e08

Browse files
Initialize Template
1 parent 0da84cd commit 0ae5e08

File tree

2 files changed

+112
-0
lines changed

2 files changed

+112
-0
lines changed

.github/workflows/scaffoldly.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Scaffoldly Deploy
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
schedule:
7+
- cron: "0 12 * * *"
8+
9+
permissions:
10+
id-token: write
11+
contents: read
12+
13+
env:
14+
# AWS_REGION: us-east-1 # Optional, defaults to us-east-1
15+
AWS_ROLE_ARN: ${{ vars.AWS_ROLE_ARN }}
16+
17+
jobs:
18+
deploy:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Deploy
25+
uses: scaffoldly/scaffoldly@v1
26+
with:
27+
secrets: ${{ toJSON(secrets) }}

README.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# A CHANGEME-FRAMEWORK App Running On AWS Lambda
2+
3+
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/scaffoldly/scaffoldly-examples/scaffoldly.yml?branch=CHANGEME-BRANCHNAME&link=https%3A%2F%2Fgithub.com%2Fscaffoldly%2Fscaffoldly-examples%2Factions)
4+
5+
This application was generated with the following command:
6+
7+
```bash
8+
CHANGEME-CREATECOMMAND
9+
```
10+
11+
✨ No modifications or SDKs were made or added to the code to "make it work" in AWS Lambda.
12+
13+
Check out our other [examples](https://github.com/scaffoldly/scaffoldly-examples) and Learn more at [scaffoldly.dev](https://scaffoldly.dev)!
14+
15+
### Working example
16+
17+
[CHANGEME-URL](CHANGEME-URL)
18+
19+
## First, Scaffoldly Config was added...
20+
21+
In the project's [`CHANGEME-CONFIGFILE`](CHANGEME-CONFIGFILE) file, the `scaffoldly` configuration was added:
22+
23+
- Note 1
24+
- Note 2
25+
26+
```
27+
CHANGEME-CONFIG
28+
```
29+
30+
See the [Scaffoldly Docs](https://scaffoldly.dev/docs/config/) for additional configuration directives.
31+
32+
## Then, deployed to AWS Lambda
33+
34+
```bash
35+
npx scaffoldly deploy
36+
```
37+
38+
See the [Scaffoldly Docs](https://scaffoldly.dev/docs/cli/#scaffoldly-deploy) for details on the `scaffoldly deploy` command.
39+
40+
### After deploy the app is available on a public URL
41+
42+
```bash
43+
🚀 Deployment Complete!
44+
🆔 App Identity: CHANGEME-IDENTITY
45+
📄 Env Files: .env.main, .env
46+
📦 Image Size: CHANGEME-IMAGESIZE MB
47+
🌎 URL: CHANGEME-URL
48+
```
49+
50+
## GitHub Action added for CI/CD
51+
52+
A [`scaffoldly.yml`](.github/workflows/scaffoldly.yml) was added to `.github/workflows` so that a push will trigger a deploy
53+
54+
```
55+
name: Scaffoldly Deploy
56+
57+
# ... snip ...
58+
59+
jobs:
60+
deploy:
61+
runs-on: ubuntu-latest
62+
steps:
63+
- name: Checkout
64+
uses: actions/checkout@v4
65+
66+
- name: Deploy
67+
uses: scaffoldly/scaffoldly@v1
68+
with:
69+
secrets: ${{ toJSON(secrets) }}
70+
```
71+
72+
See the [Scaffoldly Docs](https://scaffoldly.dev/docs/gha/) for additional GitHub Actions directives.
73+
74+
## Questions, Feedback, and Help
75+
76+
Join our [Discussions](https://github.com/scaffoldly/scaffoldly/discussions) on GitHub.
77+
Join our [Community](https://scaffoldly.dev/community) on Discord.
78+
79+
## License
80+
81+
This code is licensed under the [Apache-2.0](LICENSE.md) license.
82+
83+
The [`scaffoldly`](https://github.com/scaffoldly/scaffoldly) toolchain is licensed under the [FSL-1.1-Apache-2.0](https://github.com/scaffoldly/scaffoldly?tab=License-1-ov-file) license.
84+
85+
Copyright 2024 Scaffoldly LLC

0 commit comments

Comments
 (0)