-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
320ee62
commit a4920f6
Showing
2 changed files
with
120 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: Scaffoldly Deploy | ||
|
||
on: | ||
workflow_dispatch: | ||
push: | ||
|
||
permissions: | ||
id-token: write | ||
contents: read | ||
|
||
env: | ||
# AWS_REGION: us-east-1 # Optional, defaults to us-east-1 | ||
AWS_ROLE_ARN: ${{ vars.AWS_ROLE_ARN }} | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Deploy | ||
uses: scaffoldly/scaffoldly@v1 | ||
with: | ||
secrets: ${{ toJSON(secrets) }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
# A CHANGEME-FRAMEWORK App Running On AWS Lambda | ||
|
||
 | ||
|
||
## ✨ Quickstart | ||
|
||
Run the following command to create your own copy of this application: | ||
|
||
```bash | ||
npx scaffoldly create app --template CHANGEME-BRANCHNAME | ||
``` | ||
|
||
## Manual Setup | ||
|
||
This application was generated with the following command: | ||
|
||
```bash | ||
CHANGEME-CREATECOMMAND | ||
``` | ||
|
||
✨ No modifications or SDKs were made or added to the code to "make it work" in AWS Lambda. | ||
|
||
Check out our other [examples](https://github.com/scaffoldly/scaffoldly-examples) and Learn more at [scaffoldly.dev](https://scaffoldly.dev)! | ||
|
||
### Working example | ||
|
||
[CHANGEME-URL](CHANGEME-URL) | ||
|
||
## First, Scaffoldly Config was added... | ||
|
||
In the project's [`CHANGEME-CONFIGFILE`](CHANGEME-CONFIGFILE) file, the `scaffoldly` configuration was added: | ||
|
||
- Note 1 | ||
- Note 2 | ||
|
||
``` | ||
CHANGEME-CONFIG | ||
``` | ||
|
||
See the [Scaffoldly Docs](https://scaffoldly.dev/docs/config/) for additional configuration directives. | ||
|
||
## Then, deployed to AWS Lambda | ||
|
||
```bash | ||
npx scaffoldly deploy | ||
``` | ||
|
||
See the [Scaffoldly Docs](https://scaffoldly.dev/docs/cli/#scaffoldly-deploy) for details on the `scaffoldly deploy` command. | ||
|
||
### After deploy the app is available on a public URL | ||
|
||
```bash | ||
🚀 Deployment Complete! | ||
🆔 App Identity: CHANGEME-IDENTITY | ||
📄 Env Files: .env.main, .env | ||
📦 Image Size: CHANGEME-IMAGESIZE MB | ||
🌎 URL: CHANGEME-URL | ||
``` | ||
|
||
## GitHub Action added for CI/CD | ||
|
||
A [`scaffoldly.yml`](.github/workflows/scaffoldly.yml) was added to `.github/workflows` so that a push will trigger a deploy | ||
|
||
``` | ||
name: Scaffoldly Deploy | ||
# ... snip ... | ||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Deploy | ||
uses: scaffoldly/scaffoldly@v1 | ||
with: | ||
secrets: ${{ toJSON(secrets) }} | ||
``` | ||
|
||
See the [Scaffoldly Docs](https://scaffoldly.dev/docs/gha/) for additional GitHub Actions directives. | ||
|
||
## Questions, Feedback, and Help | ||
|
||
Join our [Discussions](https://github.com/scaffoldly/scaffoldly/discussions) on GitHub. | ||
Join our [Community](https://scaffoldly.dev/community) on Discord. | ||
|
||
## License | ||
|
||
This code is licensed under the [Apache-2.0](LICENSE.md) license. | ||
|
||
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. | ||
|
||
Copyright 2024 Scaffoldly LLC |